resistor 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1843455385e168419277b5628bade0ecafb8005
-  data.tar.gz: 0aa86e44feaf9e0e95f1e7612dd40dd1d95b9959
+  metadata.gz: 3a576d33899464a13043e8bc89b37d103a0a7fa1
+  data.tar.gz: cf556ea896a9c2be6273e812036d3c5846a8c12a
 SHA512:
-  metadata.gz: 0ebb48ab4c70a33a07256c8832499ac1ac2b9236e0c0d6f6d85dceb19a087a6b271c4d7c5662f9de34b68403921e46e5acb4ffe447db88574535c3211d6d47f0
-  data.tar.gz: edd66c46793afb5b9c9553e360377ecb9d81befafca2dabe5e6cb697450c69e4966c9ba1dea4edf8751082dcf3a8ebfbd2b2e155503c29a328327dee82a91b2b
+  metadata.gz: 01501d32e0c5486bb9b5123da1ad26d7f78a2848908198ae35c82c728137e58bef91e37e549278eacc48c93e8a1eb7c6a18053915ec78e2c87ea5fb323eecc25
+  data.tar.gz: 9c739bd8b568864ddf3689894e3d413204bcf7add187bcca50a1fc59896b72b3aec485041887f0dd7f4c79b9d5e328c61c953dbbb9b92f37f5a0914611c500a5

data/Gemfile

@@ -1,4 +1,16 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in resistor.gemspec
+gem 'rake'
+gem 'yard'
+
+group :development do
+  gem 'pry'
+  gem 'pry-doc'
+  gem 'pry-stack_explorer'
+end
+
+group :test do
+  gem 'rspec', '>= 3.1'
+end
+
 gemspec

data/README.md

@@ -1,4 +1,5 @@
 # Resistor
+Resistor is a gem for the resistor unit.  
 
 ## Installation
 
@@ -18,27 +19,47 @@ Or install it yourself as:
 
 ## Usage
 
+###Resistor Color Code Converter
+`Resistor::ColorCode.encode` **Converts a resistance value to a color code.**  
+`Resistor::ColorCode.decode` **Converts a color code to a resistance value.**  
+
 ```ruby
 require 'resistor'
 
-# Resistor Color Code Calculation
-Resistor::ColorCode.encode(4700) # => [:yellow, :purple, :red, :gold]
-Resistor::ColorCode.decode([:yellow, :purple, :red, :gold]) # => 4700.0
+Resistor::ColorCode.encode(4700)
+# => [:yellow, :purple, :red, :gold]
+Resistor::ColorCode.decode([:yellow, :purple, :red, :gold])
+# => 4700.0
+```
 
-# Combined Resistance Calculation
-#    --[r1]--          --[r4]--
-# --|        |--[r3]--|        |--
-#    --[r2]--          --[r4]--
+### Combined Resistor Calculator
+`Resistor::BasicReisistor#+` **Calculates a series combined resistance value.**  
+`Resistor::BasicReisistor#/` **Calculates a parallel combined resistance value.**  
+
+`Resistor.new` is an alias for `Resistor::BasicResistor.new`
+
+```ruby
+require 'resistor'
 
 r1 = Resistor.new(ohm: 20)
 r2 = Resistor.new(ohm: 30)
 r3 = Resistor.new(ohm: 4)
 r4 = Resistor.new(ohm: 8)
 
+#    --[r1]--          --[r4]--
+# --|        |--[r3]--|        |--
+#    --[r2]--          --[r4]--
 r5 = (r1 / r2) + r3 + (r4 / r4)
 r5.ohm # => 20.0
+```
+
+### E Series
+`Resistor::BasicReisistor#e12?` **Whether or not the resistance value is the E12 series.**  
+`Resistor::BasicReisistor#e24?` **Whether or not the resistance value is the E24 series.**  
+
+```ruby
+require 'resistor'
 
-# E Series Checker
 r1 = Resistor.new(ohm: 4700)
 r2 = Resistor.new(ohm: 62)
 

data/Rakefile

@@ -1,2 +1,9 @@
 require "bundler/gem_tasks"
 
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', 'lib/*.rb']
+end

data/lib/resistor.rb

@@ -6,8 +6,15 @@ require "resistor/combined_resistor"
 module Resistor
 
   class << self
-    def new(opt = {})
-      Resistor::BasicResistor.new(opt)
+    # Alias for Resistor::BasicResistor.new
+    #
+    # @see Resistor::BasicResistor
+    # @return [Resistor::BasicResistor]
+    # @example Create a Resistor::BasicResistor object.
+    #   r1 = Resistor.new(ohm: 20)
+    #   r2 = Resistor.new(code: ['yellow', 'purple', 'red', 'gold'])
+    def new(options = {})
+      Resistor::BasicResistor.new(options)
     end
   end
 end

data/lib/resistor/basic_resistor.rb

@@ -3,15 +3,27 @@ module Resistor
 
     attr_reader :ohm, :code, :error_range
 
-    def initialize(ohm:nil, code:nil, error_range: 5.0)
-      opt = {error_range: error_range}
-      if ohm
-        @ohm = ohm.to_f
+    # Initializes a new BasicResistor object.
+    # Both the ohm and code parameter are optional,
+    # but at least one of them must be supplied.
+    #
+    # @option options [Integer, Float] :ohm(nil) resistance value
+    # @option options [Array<Symbol>, Array<String>] :code(nil) color code
+    # @option options [Integer, Float] :error_range(5.0)
+    # @raise [ArgumentError] The ohm or code parameter must be supplied.
+    #   Error raised if neither parameter is supplied.
+    # @return [Resistor::BasicResistor]
+    # def initialize(ohm:nil, code:nil, error_range: 5.0)
+    def initialize(options = {})
+      options[:error_range] ||= 5.0
+      opt = {:error_range => options[:error_range]}
+      if options[:ohm]
+        @ohm = options[:ohm].to_f
         @code = Resistor::ColorCode.encode(@ohm, opt)
-        @error_range = error_range
-      elsif code
-        raise ArgumentError unless code.is_a? Array
-        @code = code.map(&:to_sym)
+        @error_range = options[:error_range]
+      elsif options[:code]
+        raise ArgumentError unless options[:code].is_a? Array
+        @code = options[:code].map(&:to_sym)
         @ohm = Resistor::ColorCode.decode(@code)
         @error_range = Resistor::ColorCode::ERROR_RANGE[@code[3].to_sym]
       else
@@ -19,25 +31,43 @@ module Resistor
       end
     end
 
+    # Set a resistance value.
+    # When the resistance value is changed, the color code is also changed.
+    #
+    # @param ohm [Integer, Float] resistance value
     def ohm=(ohm)
       @ohm = ohm.to_f
       @code = Resistor::ColorCode.encode(@ohm)
     end
 
+    # Set a color code.
+    # When the color code is changed, the resistance value is also changed,
+    # and the error range is also changed.
+    #
+    # @param code [Array<Symbol>, Array<String>] color code
     def code=(code)
       @code = code.map(&:to_sym)
       @ohm = Resistor::ColorCode.decode(@code)
       @error_range = Resistor::ColorCode::ERROR_RANGE[@code[3].to_sym]
     end
 
+    # Calculates a series combined resistance value.
+    #
+    # @param other [Resistor::BasicResistor, Resistor::CombinedResistor]
+    # @return [Resistor::CombinedResistor]
     def +(other)
       Resistor::CombinedResistor.new(@ohm + other.ohm)
     end
 
+    # Calculates a parallel combined resistance value.
+    #
+    # @param other [Resistor::BasicResistor, Resistor::CombinedResistor]
+    # @return [Resistor::CombinedResistor]
     def /(other)
       Resistor::CombinedResistor.new(1 / (1 / @ohm + 1 / other.ohm))
     end
 
+    # @return [Boolean] Whether or not the resistance value is the E12 series.
     def e12?
       num0 = Resistor::ColorCode::NUM[@code[0]]
       num1 = Resistor::ColorCode::NUM[@code[1]]
@@ -49,6 +79,7 @@ module Resistor
       return false
     end
 
+    # @return [Boolean] Whether or not the resistance value is the E24 series.
     def e24?
       num0 = Resistor::ColorCode::NUM[@code[0]]
       num1 = Resistor::ColorCode::NUM[@code[1]]

data/lib/resistor/color_code.rb

@@ -1,7 +1,7 @@
 module Resistor
   module ColorCode
 
-    # 1桁目、2桁目の数値
+    # 1st Band, 2nd Band
     NUM = {
       :black  => 0,
       :brown  => 1,
@@ -15,7 +15,7 @@ module Resistor
       :white  => 9
     }.freeze
 
-    # 3桁目で指定される乗数
+    # Multiplier
     MULT = {
       :black  => 0,
       :brown  => 1,
@@ -28,7 +28,7 @@ module Resistor
       :silver => -2
     }.freeze
 
-    # 4桁目で指定される誤差範囲
+    # Tolerance
     ERROR_RANGE = {
       :brown  => 1.0,
       :red    => 2.0,
@@ -40,7 +40,6 @@ module Resistor
       :silver => 10.0
     }.freeze
 
-    # E12系列
     E12_SERIES = {
       1 => [0, 2, 5, 8],
       2 => [2, 7],
@@ -51,7 +50,6 @@ module Resistor
       8 => [2],
     }.freeze
 
-    # E24系列
     E24_SERIES = {
       1 => [0, 1, 2, 3, 5, 6, 8],
       2 => [0, 2, 4, 7],
@@ -64,32 +62,43 @@ module Resistor
       9 => [1]
     }.freeze
 
-    # 抵抗値 -> カラーコード
-    def self.encode(ohm, error_range: 5.0)
+
+    # Converts a resistance value to a color code.
+    # The value must be between 0.1 and 99_000_000.
+    #
+    # @param ohm [Integer, Float] resistance value
+    # @option options [Integer, Float] :error_range(5.0)
+    # @raise [ArgumentError] Error raised
+    #   when the supplied resistance value is less than 0.1.
+    # @return [Array<Symbol>] color code
+    def self.encode(ohm, options = {:error_range => 5.0})
       return [NUM.key(0)] if ohm == 0
       raise ArgumentError if ohm < 0.1
 
-      # 0.1以上で1より小さい
       if ohm < 1
         ohm_str = (ohm*100).to_s.split('')
         [NUM.key(ohm_str[0].to_i), NUM.key(ohm_str[1].to_i),
-         MULT.key(-2), ERROR_RANGE.key(error_range)]
+         MULT.key(-2), ERROR_RANGE.key(options[:error_range])]
 
-      # 1以上で10より小さい(1桁)
       elsif ohm < 10
         ohm_str = (ohm*10).to_s.split('')
         [NUM.key(ohm_str[0].to_i), NUM.key(ohm_str[1].to_i),
-         MULT.key(-1), ERROR_RANGE.key(error_range)]
+         MULT.key(-1), ERROR_RANGE.key(options[:error_range])]
 
-      # 2桁以上
       else
         ohm_str = ohm.to_i.to_s.split('')
         [NUM.key(ohm_str[0].to_i), NUM.key(ohm_str[1].to_i),
-         MULT.key(ohm_str.size - 2), ERROR_RANGE.key(error_range)]
+         MULT.key(ohm_str.size - 2), ERROR_RANGE.key(options[:error_range])]
       end
     end
 
-    # カラーコード -> 抵抗値
+    # Converts a color code to a resistance value.
+    #
+    # @param code [Array<Symbol>, Array<String>] color code
+    # @raise [ArgumentError] Error raised
+    #   when the supplied color code is not an array,
+    #   or when the color of the first band is black.
+    # @return [Float] resistance value
     def self.decode(code)
       raise ArgumentError unless code.is_a? Array
       code = code.map(&:to_sym)

data/lib/resistor/combined_resistor.rb

@@ -3,14 +3,28 @@ module Resistor
 
     attr_reader :ohm
 
+    # Initializes a new CombinedResistor object.
+    #
+    # @see BasicResistor#+
+    # @see BasicResistor#/
+    # @param ohm [Float] resistance value
+    # @return [Resistor::CombinedResistor]
     def initialize(ohm)
       @ohm = ohm.to_f
     end
 
+    # Calculates a series combined resistance value.
+    #
+    # @param other [Resistor::BasicResistor, Resistor::CombinedResistor]
+    # @return [Resistor::CombinedResistor]
     def +(other)
       Resistor::CombinedResistor.new(@ohm + other.ohm)
     end
 
+    # Calculates a parallel combined resistance value.
+    #
+    # @param other [Resistor::BasicResistor, Resistor::CombinedResistor]
+    # @return [Resistor::CombinedResistor]
     def /(other)
       Resistor::CombinedResistor.new(1 / (1 / @ohm + 1 / other.ohm))
     end

data/lib/resistor/version.rb

@@ -1,3 +1,3 @@
 module Resistor
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/resistor.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["seinosuke"]
   spec.email         = ["seinosuke.3606@gmail.com"]
   spec.summary       = %q{Resistor gem}
-  spec.description   = %q{gem for resistor}
+  spec.description   = %q{Gem for resistor}
   spec.homepage      = "https://github.com/seinosuke/resistor"
   spec.license       = "MIT"
 
@@ -19,6 +19,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.1"
 end

data/spec/basic_resistor_spec.rb

@@ -31,6 +31,12 @@ describe Resistor::BasicResistor do
 
       it { expect { is_expected }.to raise_error(ArgumentError) }
     end
+
+    context '許容差を指定した場合' do
+      resistor = Resistor.new(ohm: 100, error_range: 0.1)
+      it { expect(resistor.code[3]).to eq :purple }
+      it { expect(resistor.error_range).to eq 0.1 }
+    end
   end
 
   describe '#+, #/' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resistor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - seinosuke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-19 00:00:00.000000000 Z
+date: 2015-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,35 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-description: gem for resistor
+description: Gem for resistor
 email:
 - seinosuke.3606@gmail.com
 executables: []
@@ -102,3 +74,4 @@ test_files:
 - spec/basic_resistor_spec.rb
 - spec/color_code_spec.rb
 - spec/spec_helper.rb
+has_rdoc: