resistor 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a576d33899464a13043e8bc89b37d103a0a7fa1
-  data.tar.gz: cf556ea896a9c2be6273e812036d3c5846a8c12a
+  metadata.gz: 4ba5f3aa26c28e62800c94ee3bea8eab62b9295b
+  data.tar.gz: 78e020b33d5eaed94e1956a0732626c16189e510
 SHA512:
-  metadata.gz: 01501d32e0c5486bb9b5123da1ad26d7f78a2848908198ae35c82c728137e58bef91e37e549278eacc48c93e8a1eb7c6a18053915ec78e2c87ea5fb323eecc25
-  data.tar.gz: 9c739bd8b568864ddf3689894e3d413204bcf7add187bcca50a1fc59896b72b3aec485041887f0dd7f4c79b9d5e328c61c953dbbb9b92f37f5a0914611c500a5
+  metadata.gz: 4d45490081759694cdd282f3bcc59c00777d6c512149efac8ef79806c606ca461008ef541c178133bf527b279a5dedca60a2a3f0203af2047bc49730ed2aa0c4
+  data.tar.gz: 8b952ccbbe8da1a138ed560f8a4e0a1719f09e651f39881d9fd86fda3c91ccda5f91c5e85da785bc7a487d319af32095006c8a682c2244df1c6345390d70a890

data/Gemfile

@@ -11,6 +11,8 @@ end
 
 group :test do
   gem 'rspec', '>= 3.1'
+  gem 'guard-rspec', '4.5.0'
+  gem 'libnotify', '0.9.1'
 end
 
 gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# coding: utf-8
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch('spec/spec_helper.rb')     { 'spec' }
+
+  watch(/lib\/(.+)\.rb/)           { 'spec' }
+  watch(/lib\/resistor\/(.+)\.rb/)  { 'spec' }
+end

data/README.md

@@ -1,4 +1,5 @@
 # Resistor
+[![Gem Version](https://badge.fury.io/rb/resistor.svg)](http://badge.fury.io/rb/resistor)  
 Resistor is a gem for the resistor unit.  
 
 ## Installation
@@ -41,10 +42,10 @@ Resistor::ColorCode.decode([:yellow, :purple, :red, :gold])
 ```ruby
 require 'resistor'
 
-r1 = Resistor.new(ohm: 20)
-r2 = Resistor.new(ohm: 30)
-r3 = Resistor.new(ohm: 4)
-r4 = Resistor.new(ohm: 8)
+r1 = Resistor.new(20)
+r2 = Resistor.new(30)
+r3 = Resistor.new(4)
+r4 = Resistor.new(8)
 
 #    --[r1]--          --[r4]--
 # --|        |--[r3]--|        |--
@@ -60,8 +61,8 @@ r5.ohm # => 20.0
 ```ruby
 require 'resistor'
 
-r1 = Resistor.new(ohm: 4700)
-r2 = Resistor.new(ohm: 62)
+r1 = Resistor.new(4700)
+r2 = Resistor.new(62)
 
 r1.e12? # => true
 r1.e24? # => true

data/lib/resistor.rb

@@ -13,8 +13,8 @@ module Resistor
     # @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)
+    def new(arg, options = {})
+      Resistor::BasicResistor.new(arg, options)
     end
   end
 end

data/lib/resistor/basic_resistor.rb

@@ -1,31 +1,33 @@
 module Resistor
   class BasicResistor
 
-    attr_reader :ohm, :code, :error_range
+    attr_reader :ohm, :code, :tolerance
 
     # 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)
+    # @overload initialize(arg, options = {})
+    #   @param arg [Integer, Float] A resistance value.
+    # @overload initialize(arg, options = {})
+    #   @param arg [Array<Symbol>, Array<String>] A color code.
+    # @option options [Integer, Float] :tolerance(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
+    def initialize(arg, options = {})
+      options[:tolerance] ||= 5.0
+      opt = {:tolerance => options[:tolerance]}
+
+      case arg
+      when Integer, Float
+        @ohm = arg.to_f
         @code = Resistor::ColorCode.encode(@ohm, opt)
-        @error_range = options[:error_range]
-      elsif options[:code]
-        raise ArgumentError unless options[:code].is_a? Array
-        @code = options[:code].map(&:to_sym)
+        @tolerance = options[:tolerance]
+      when Array
+        @code = arg.map(&:to_sym)
         @ohm = Resistor::ColorCode.decode(@code)
-        @error_range = Resistor::ColorCode::ERROR_RANGE[@code[3].to_sym]
+        @tolerance = Resistor::ColorCode::TOLERANCE[@code[3].to_sym]
       else
         raise ArgumentError
       end
@@ -42,13 +44,13 @@ module Resistor
 
     # Set a color code.
     # When the color code is changed, the resistance value is also changed,
-    # and the error range is also changed.
+    # and the tolerance 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]
+      @tolerance = Resistor::ColorCode::TOLERANCE[@code[3].to_sym]
     end
 
     # Calculates a series combined resistance value.
@@ -58,6 +60,7 @@ module Resistor
     def +(other)
       Resistor::CombinedResistor.new(@ohm + other.ohm)
     end
+    alias_method :-, :+
 
     # Calculates a parallel combined resistance value.
     #
@@ -66,11 +69,12 @@ module Resistor
     def /(other)
       Resistor::CombinedResistor.new(1 / (1 / @ohm + 1 / other.ohm))
     end
+    alias_method :|, :/
 
     # @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]]
+      num0 = Resistor::ColorCode::DIGIT[@code[0]]
+      num1 = Resistor::ColorCode::DIGIT[@code[1]]
       Resistor::ColorCode::E12_SERIES.each do |key, val|
         if num0 == key
           return true if val.any? { |e| e == num1 }
@@ -81,8 +85,8 @@ module Resistor
 
     # @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]]
+      num0 = Resistor::ColorCode::DIGIT[@code[0]]
+      num1 = Resistor::ColorCode::DIGIT[@code[1]]
       Resistor::ColorCode::E24_SERIES.each do |key, val|
         if num0 == key
           return true if val.any? { |e| e == num1 }

data/lib/resistor/color_code.rb

@@ -1,8 +1,7 @@
 module Resistor
   module ColorCode
 
-    # 1st Band, 2nd Band
-    NUM = {
+    DIGIT = {
       :black  => 0,
       :brown  => 1,
       :red    => 2,
@@ -15,8 +14,7 @@ module Resistor
       :white  => 9
     }.freeze
 
-    # Multiplier
-    MULT = {
+    MULTIPLIER = {
       :black  => 0,
       :brown  => 1,
       :red    => 2,
@@ -28,8 +26,7 @@ module Resistor
       :silver => -2
     }.freeze
 
-    # Tolerance
-    ERROR_RANGE = {
+    TOLERANCE = {
       :brown  => 1.0,
       :red    => 2.0,
       :orange => 0.05,
@@ -67,28 +64,28 @@ module Resistor
     # 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)
+    # @option options [Integer, Float] :tolerance(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
+    def self.encode(ohm, options = {:tolerance => 5.0})
+      return [DIGIT.key(0)] if ohm == 0
       raise ArgumentError if ohm < 0.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(options[:error_range])]
+        [DIGIT.key(ohm_str[0].to_i), DIGIT.key(ohm_str[1].to_i),
+         MULTIPLIER.key(-2), TOLERANCE.key(options[:tolerance])]
 
       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(options[:error_range])]
+        [DIGIT.key(ohm_str[0].to_i), DIGIT.key(ohm_str[1].to_i),
+         MULTIPLIER.key(-1), TOLERANCE.key(options[:tolerance])]
 
       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(options[:error_range])]
+        [DIGIT.key(ohm_str[0].to_i), DIGIT.key(ohm_str[1].to_i),
+         MULTIPLIER.key(ohm_str.size - 2), TOLERANCE.key(options[:tolerance])]
       end
     end
 
@@ -105,7 +102,7 @@ module Resistor
       return 0.0 if code == [:black]
       raise ArgumentError if code[0] == :black
 
-      ohm = (NUM[code[0]]*10 + NUM[code[1]]) * 10**MULT[code[2]]
+      ohm = (DIGIT[code[0]]*10 + DIGIT[code[1]]) * 10**MULTIPLIER[code[2]]
       return ohm.to_f
     end
   end

data/lib/resistor/combined_resistor.rb

@@ -20,6 +20,7 @@ module Resistor
     def +(other)
       Resistor::CombinedResistor.new(@ohm + other.ohm)
     end
+    alias_method :-, :+
 
     # Calculates a parallel combined resistance value.
     #
@@ -28,5 +29,6 @@ module Resistor
     def /(other)
       Resistor::CombinedResistor.new(1 / (1 / @ohm + 1 / other.ohm))
     end
+    alias_method :|, :/
   end
 end

data/lib/resistor/version.rb

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

data/spec/basic_resistor_spec.rb

@@ -5,70 +5,83 @@ require_relative "spec_helper"
 describe Resistor::BasicResistor do
 
   describe '::new' do
-    let(:resistor) { Resistor.new(ohm: ohm, code: code) }
+    let(:resistor) { Resistor.new(arg) }
 
     context '抵抗値を指定した場合' do
-      let(:ohm) { 4700 }
-      let(:code) { nil }
+      let(:arg) { 4700 }
 
       it { expect(resistor.ohm).to eq 4700.0 }
       it { expect(resistor.code).to eq [:yellow, :purple, :red, :gold] }
-      it { expect(resistor.error_range).to eq 5.0 }
+      it { expect(resistor.tolerance).to eq 5.0 }
     end
 
     context '抵抗値を指定した場合' do
-      let(:ohm) { nil }
-      let(:code) { ['brown', 'black', 'blue', 'silver'] }
+      let(:arg) { ['brown', 'black', 'blue', 'silver'] }
 
       it { expect(resistor.ohm).to eq 10_000_000 }
       it { expect(resistor.code).to eq [:brown, :black, :blue, :silver] }
-      it { expect(resistor.error_range).to eq 10.0 }
+      it { expect(resistor.tolerance).to eq 10.0 }
     end
 
     context 'どちらも指定しなかった場合' do
-      let(:ohm) { nil }
-      let(:code) { nil }
+      let(:arg) { nil }
 
       it { expect { is_expected }.to raise_error(ArgumentError) }
     end
 
     context '許容差を指定した場合' do
-      resistor = Resistor.new(ohm: 100, error_range: 0.1)
+      resistor = Resistor.new(100, tolerance: 0.1)
       it { expect(resistor.code[3]).to eq :purple }
-      it { expect(resistor.error_range).to eq 0.1 }
+      it { expect(resistor.tolerance).to eq 0.1 }
     end
   end
 
   describe '#+, #/' do
     context '直列接続の合成抵抗' do
-      r1 = Resistor.new(ohm: 100)
-      r2 = Resistor.new(ohm: 200)
-      r3 = Resistor.new(ohm: 300)
+      r1 = Resistor.new(100)
+      r2 = Resistor.new(200)
+      r3 = Resistor.new(300)
 
       it { expect((r1 + r2 + r3).ohm).to eq 600.0 }
     end
 
     context '並列接続の合成抵抗' do
-      r1 = Resistor.new(ohm: 30)
-      r2 = Resistor.new(ohm: 15)
-      r3 = Resistor.new(ohm: 10)
+      r1 = Resistor.new(30)
+      r2 = Resistor.new(15)
+      r3 = Resistor.new(10)
 
       it { expect((r1 / r2 / r3).ohm).to eq 5.0 }
     end
 
     context '並列と直列を合わせた合成抵抗' do
-      r1 = Resistor.new(ohm: 20)
-      r2 = Resistor.new(ohm: 30)
-      r3 = Resistor.new(ohm: 4)
-      r4 = Resistor.new(ohm: 8)
+      r1 = Resistor.new(20)
+      r2 = Resistor.new(30)
+      r3 = Resistor.new(4)
+      r4 = Resistor.new(8)
 
       it { expect(((r1 / r2) + r3 + (r4 / r4)).ohm).to eq 20.0 }
     end
+
+    context '#+のエイリアスメソッドを使用した場合' do
+      r1 = Resistor.new(100)
+      original_name = (r1 + r1 + r1).ohm
+      new_name = (r1 - r1 - r1).ohm
+
+      it { expect(original_name == new_name).to be_truthy }
+    end
+
+    context '#/のエイリアスメソッドを使用した場合' do
+      r1 = Resistor.new(100)
+      original_name = (r1 / r1 / r1).ohm
+      new_name = (r1 | r1 | r1).ohm
+
+      it { expect(original_name == new_name).to be_truthy }
+    end
   end
 
   describe '#ohm=, #code=' do
     context '抵抗値を変更する場合' do
-      resistor = Resistor.new(ohm: 100)
+      resistor = Resistor.new(100)
       resistor.ohm = 4.7
 
       it { expect(resistor.ohm).to eq 4.7 }
@@ -76,44 +89,44 @@ describe Resistor::BasicResistor do
     end
 
     context 'カラーコードを変更する場合' do
-      resistor = Resistor.new(ohm: 100)
+      resistor = Resistor.new(100)
       resistor.code = ['green', 'brown', 'silver', 'brown']
 
       it { expect(resistor.ohm).to eq 0.51 }
       it { expect(resistor.code).to eq [:green, :brown, :silver, :brown] }
-      it { expect(resistor.error_range).to eq 1.0 }
+      it { expect(resistor.tolerance).to eq 1.0 }
     end
   end
 
   describe '#e12?' do
     context 'E12系列である場合' do
-      it { expect(Resistor.new(ohm: 0.12).e12?).to eq true }
-      it { expect(Resistor.new(ohm: 3.3).e12?).to eq true }
-      it { expect(Resistor.new(ohm: 47).e12?).to eq true }
-      it { expect(Resistor.new(ohm: 82_000_000).e12?).to eq true }
+      it { expect(Resistor.new(0.12).e12?).to eq true }
+      it { expect(Resistor.new(3.3).e12?).to eq true }
+      it { expect(Resistor.new(47).e12?).to eq true }
+      it { expect(Resistor.new(82_000_000).e12?).to eq true }
     end
 
     context 'E12系列でない場合' do
-      it { expect(Resistor.new(ohm: 0.13).e12?).to eq false }
-      it { expect(Resistor.new(ohm: 3.8).e12?).to eq false }
-      it { expect(Resistor.new(ohm: 55).e12?).to eq false }
-      it { expect(Resistor.new(ohm: 70_000_000).e12?).to eq false }
+      it { expect(Resistor.new(0.13).e12?).to eq false }
+      it { expect(Resistor.new(3.8).e12?).to eq false }
+      it { expect(Resistor.new(55).e12?).to eq false }
+      it { expect(Resistor.new(70_000_000).e12?).to eq false }
     end
   end
 
   describe '#e24?' do
     context 'E24系列である場合' do
-      it { expect(Resistor.new(ohm: 0.1).e24?).to eq true }
-      it { expect(Resistor.new(ohm: 3).e24?).to eq true }
-      it { expect(Resistor.new(ohm: 47_000).e24?).to eq true }
-      it { expect(Resistor.new(ohm: 10_000_000).e24?).to eq true }
+      it { expect(Resistor.new(0.1).e24?).to eq true }
+      it { expect(Resistor.new(3).e24?).to eq true }
+      it { expect(Resistor.new(47_000).e24?).to eq true }
+      it { expect(Resistor.new(10_000_000).e24?).to eq true }
     end
 
     context 'E24系列でない場合' do
-      it { expect(Resistor.new(ohm: 0.92).e24?).to eq false }
-      it { expect(Resistor.new(ohm: 8.3).e24?).to eq false }
-      it { expect(Resistor.new(ohm: 23_000).e24?).to eq false }
-      it { expect(Resistor.new(ohm: 52_000_000).e24?).to eq false }
+      it { expect(Resistor.new(0.92).e24?).to eq false }
+      it { expect(Resistor.new(8.3).e24?).to eq false }
+      it { expect(Resistor.new(23_000).e24?).to eq false }
+      it { expect(Resistor.new(52_000_000).e24?).to eq false }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resistor
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - seinosuke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-25 00:00:00.000000000 Z
+date: 2015-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -34,6 +34,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -66,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Resistor gem