Contents

module Ravelry

  # The API endpoint for fetching `Needle` objects can be found in {Ravelry::Needles}.
  #
  # A `Needle` object can be created by several different endpoints but is currently only implemented in {Ravelry::Misc}.
  #
  class Needle
    attr_reader :id, :metric, :metric_name, :hook, :name, :pretty_metric, :us, :description, :length, :needle_size_id, :type_name, :comment, :needle_type, :needle_type_id, :data
    def initialize(data)
      @data = data
      @id = data[:id]
      # Crochet hook size.
      # Corresponding to this metric size, if one exists.
      #
      @hook = data[:hook]
      # US size number corresponding to this metric size, if one exists
      # 
      @us = data[:us]
      # Combination of US and metric.
      # Example: "US 4  - 3.5 mm"
      #
      @name = data[:name]
      # Metric designation for hook size.
      #
      @metric = data[:metric]
      # Metric size for knitting needles (Integer or Float).
      #
      @metric_name = data[:metric_name]
      # Metric size for knitting needles (pretty format).
      #
      @pretty_metric = data[:pretty_metric]

      @description = data[:description]
      @length = data[:length]
      @needle_size_id = data[:needle_size_id]
      @type_name = data[:type_name]
      @needle_type = data[:needle_type]
      @needle_type_id = data[:needle_type_id]
      @comment = data[:comment]
    end

    # Takes the US size and turns it into a string.
    # Example: "US 4"
    #
    def us_string
      "US #{@us}".strip
    end

    # Takes the metric size and turns it into a string.
    # Example: "3.5 mm"
    #
    def metric_string
      "#{@metric} mm"
    end

    # Sets @type to 'knitting' or 'crochet'.
    #
    def type
      if hook || data[:crochet]
        'crochet'
      else
        'knitting'
      end
    end

    def knitting?
      type == 'knitting'
    end

    def crochet?
      type == 'crochet'
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
ravelry-0.2.0	lib/ravelry/needle.rb
ravelry-0.1.0	lib/ravelry/needle.rb
ravelry-0.0.9	lib/ravelry/needle.rb
ravelry-0.0.8	lib/ravelry/needle.rb
ravelry-0.0.7	lib/ravelry/needle.rb
ravelry-0.0.6	lib/ravelry/needle.rb