circuits 0.2.6 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzJiYjI2N2YzMjI5ZDJmOGQ0YjM4NDg5YzQzYjFlYjgzNTQ3Yjc5Nw==
+    NzMwZGNkMDQ1ZmY2ZTVlMjhjZjA1ODUyZTFmNDc1OTMyZTA2YmM1Mw==
   data.tar.gz: !binary |-
-    MThiMDgxYzExOTY1YTk1ZGNlNTc2OTc3MTQ2ZjA4ZDdhMGY5NThlNw==
+    M2ZjMmNmYzM5OGExZjAxMWU0MjI3NzRlZTYyY2QzYWVjNjI1MDc0Zg==
 SHA512:
   metadata.gz: !binary |-
-    ODhlMWYxZTllZTIzNDA5NTBlZGM1ZmJiMGExZDFmYWMyOTkzNWIzNDA5NTFm
-    Y2JiNWVlOThmZGJiNzMwYTE1NWZmOGU3NGU0YzY3ZGRlNGMxYzg0MjUwNjRk
-    MDMzYTg2YzdiMTM3NTA5NWZlYTg5Zjg5ZmQxOThlMTVjNTQxMDQ=
+    YWJkYmY2NTE1YWYzMWU0OTk2NjIzZDNkYTY1MTE3NDEzOTkzZDg5MThlMzZh
+    YjhiNmE5NjRmYTRhZDNmNTE4Yjc0ZDllZTY3OGIxM2Q4MjMyZmM1YWU3ZjM1
+    N2FlNTg1YWNlNWQ5NTFjZjEwOTlhOTdjNzRmZWFkYWIwZWZlZDU=
   data.tar.gz: !binary |-
-    NzJkMjFhYzI1YjI2MWIwMTA4ZDc1Y2I2NzhkNzI2ZjBkNDdmNzM3MzM3MDEw
-    YWE1ZmZmYWE4NTk0NWM5ZTc4M2ZlMDFmOWI5N2Q2ZjRiNDJhNmVmMGVkNTNh
-    N2Q1MGMwMzA0YzkxNTUyNzBhOWZhYzQyMGZmMWFiMjMwNDI3Yzg=
+    OWNmNzVkMTQyMWQ3MWJjNDFlNjJkZGZmYjZjYzQ1OGU5NGY5Y2JjNGM2ODA4
+    MTRjOWM5NjI3MWQ3OWJmZWRmZTBkMGUxZjI0YjRmZDg1NGE2M2I4YTE3ZjZh
+    YjdlYTRkMDI2OGNhMmVkZWEzOTc1NzU2NTJlZDUxNjBlODc1MGY=

data/.rspec

@@ -1,2 +1,3 @@
 --color
+--format doc
 --require spec_helper

data/README.md

@@ -2,6 +2,7 @@
 [![Gem Version](https://badge.fury.io/rb/circuits.svg)](https://badge.fury.io/rb/circuits)
 [![Coverage Status](https://coveralls.io/repos/meringu/circuits/badge.svg?branch=master&service=github)](https://coveralls.io/github/meringu/circuits?branch=master)
 [![Code Climate](https://codeclimate.com/github/meringu/circuits/badges/gpa.svg)](https://codeclimate.com/github/meringu/circuits)
+[![Dependency Status](https://gemnasium.com/meringu/circuits.svg)](https://gemnasium.com/meringu/circuits)
 [![docs](http://inch-ci.org/github/meringu/circuits.svg?branch=master)](http://inch-ci.org/github/meringu/circuits)
 
 # Circuits
@@ -50,7 +51,7 @@ and_gate.outputs[0].get # false
 
 ```ruby
 and_gate = Circuits::Component::And.new
-not_gate = Circuits::Component::And.new(inputs: [and_gate.outputs[0])
+not_gate = Circuits::Component::Not.new(inputs: [and_gate.outputs[0]])
 ```
 
 ## Contributing

data/Rakefile

@@ -1,6 +1,23 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'reek/rake/task'
+require 'yard'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  # only show the files with failures
+  task.formatters = ['files']
+end
+
+Reek::Rake::Task.new
+
+task lint: [:rubocop, :reek]
+
+YARD::Rake::YardocTask.new(:yard) do |t|
+  t.stats_options = ['--list-undoc']
+end

data/circuits.gemspec

@@ -21,4 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'rubocop', '~> 0.34'
+  spec.add_development_dependency 'reek', '~> 3.5'
+  spec.add_development_dependency 'yard', '~> 0.8.7'
 end

data/lib/circuits/component/xnor.rb

@@ -8,7 +8,7 @@ module Circuits
 
       # Sets the output to be the result of a logical XNOR of the inputs
       def tick
-        outputs[0].set(inputs[0].get == inputs[1].get)
+        outputs[0].set(!inputs.map(&:get).inject(:^))
       end
 
       private

data/lib/circuits/component/xor.rb

@@ -8,7 +8,7 @@ module Circuits
 
       # Sets the output to be the result of a logical XOR of the inputs
       def tick
-        outputs[0].set(inputs[0].get != inputs[1].get)
+        outputs[0].set(inputs.map(&:get).inject(:^))
       end
 
       private

data/lib/circuits/component.rb

@@ -8,10 +8,13 @@ module Circuits
   module Component
     # Creates the Component with inputs and outputs
     # @param opts [Hash] options to create the Component with
-    # @option opts [Array<Input>] :inputs The array of inputs to use
+    # @option opts [Array<Input>, FixNum] :inputs The array of inputs to use, or
+    #   the number of inputs to create
     def initialize(opts = {})
-      @inputs = opts[:inputs] ||
-                input_count.times.collect { Circuits::Terminal::Input.new }
+      @inputs = opts[:inputs] if opts[:inputs].is_a? Array
+      @inputs = create_inputs opts[:inputs] if opts[:inputs].is_a? Integer
+      @inputs = create_inputs input_count if opts[:inputs].nil?
+
       @outputs = output_count.times.collect { Circuits::Terminal::Output.new }
       setup
     end
@@ -41,6 +44,17 @@ module Circuits
     def output_count
       fail NotImplementedError
     end
+
+    # Creates an array of N inputs, where N is equal to or greater than the
+    #   default number of inputs for this component
+    # @param n [FixNum] The number of inputs to create
+    # @return [Array<Input>] An array of inputs
+    def create_inputs(n)
+      if n < input_count
+        fail ArgumentError, "Invalid number of inputs, #{self.class} requires at least #{input_count} inputs"
+      end
+      n.times.collect { Circuits::Terminal::Input.new }
+    end
 
     def setup
     end

data/lib/circuits/version.rb

@@ -1,5 +1,5 @@
 # Circuits allows you to express logical circuits in code
 module Circuits
   # The version of the Circuits gem
-  VERSION = '0.2.6'
+  VERSION = '0.3.0'
 end

data/spec/unit/circuits/component/and_spec.rb

@@ -55,5 +55,53 @@ describe Circuits::Component::And do
         end
       end
     end
+
+    [3, 4, 8].each do |n|
+      context "with #{n} inputs" do
+        subject { Circuits::Component::And.new inputs: n }
+
+        before do
+          n.times { |x| subject.inputs[x].set inputs[x] }
+        end
+
+        context 'when all inputs are true' do
+          let(:inputs) { n.times.collect { true } }
+
+          it '= true' do
+            subject.tick
+            subject.tock
+            expect(subject.outputs[0].get).to eq(true)
+          end
+        end
+
+        context 'when all inputs are false' do
+          let(:inputs) { n.times.collect { false } }
+
+          it '= false' do
+            subject.tick
+            subject.tock
+            expect(subject.outputs[0].get).to eq(false)
+          end
+        end
+
+        context 'when any input is false' do
+          n.times do |x|
+            context "when input #{x} is false" do
+              let(:inputs) do
+                inputs =  n.times.collect { true }
+                inputs[x] = false
+                inputs
+              end
+
+              it '= false' do
+                subject.tick
+                subject.tock
+                expect(subject.outputs[0].get).to eq(false)
+              end
+            end
+          end
+        end
+      end
+    end
   end
 end

data/spec/unit/circuits/component/nand_spec.rb

@@ -55,5 +55,52 @@ describe Circuits::Component::Nand do
         end
       end
     end
+    [3, 4, 8].each do |n|
+      context "with #{n} inputs" do
+        subject { Circuits::Component::Nand.new inputs: n }
+
+        before do
+          n.times { |x| subject.inputs[x].set inputs[x] }
+        end
+
+        context 'when all inputs are true' do
+          let(:inputs) { n.times.collect { true } }
+
+          it '= false' do
+            subject.tick
+            subject.tock
+            expect(subject.outputs[0].get).to eq(false)
+          end
+        end
+
+        context 'when all inputs are false' do
+          let(:inputs) { n.times.collect { false } }
+
+          it '= true' do
+            subject.tick
+            subject.tock
+            expect(subject.outputs[0].get).to eq(true)
+          end
+        end
+
+        context 'when any input is false' do
+          n.times do |x|
+            context "when input #{x} is false" do
+              let(:inputs) do
+                inputs =  n.times.collect { true }
+                inputs[x] = false
+                inputs
+              end
+
+              it '= true' do
+                subject.tick
+                subject.tock
+                expect(subject.outputs[0].get).to eq(true)
+              end
+            end
+          end
+        end
+      end
+    end
   end
 end

data/spec/unit/circuits/component/nor_spec.rb

@@ -55,5 +55,52 @@ describe Circuits::Component::Nor do
         end
       end
     end
+    [3, 4, 8].each do |n|
+      context "with #{n} inputs" do
+        subject { Circuits::Component::Nor.new inputs: n }
+
+        before do
+          n.times { |x| subject.inputs[x].set inputs[x] }
+        end
+
+        context 'when all inputs are true' do
+          let(:inputs) { n.times.collect { true } }
+
+          it '= false' do
+            subject.tick
+            subject.tock
+            expect(subject.outputs[0].get).to eq(false)
+          end
+        end
+
+        context 'when all inputs are false' do
+          let(:inputs) { n.times.collect { false } }
+
+          it '= true' do
+            subject.tick
+            subject.tock
+            expect(subject.outputs[0].get).to eq(true)
+          end
+        end
+
+        context 'when any input is false' do
+          n.times do |x|
+            context "when input #{x} is false" do
+              let(:inputs) do
+                inputs =  n.times.collect { true }
+                inputs[x] = false
+                inputs
+              end
+
+              it '= false' do
+                subject.tick
+                subject.tock
+                expect(subject.outputs[0].get).to eq(false)
+              end
+            end
+          end
+        end
+      end
+    end
   end
 end

data/spec/unit/circuits/component/or_spec.rb

@@ -55,5 +55,52 @@ describe Circuits::Component::Or do
         end
       end
     end
+    [3, 4, 8].each do |n|
+      context "with #{n} inputs" do
+        subject { Circuits::Component::Or.new inputs: n }
+
+        before do
+          n.times { |x| subject.inputs[x].set inputs[x] }
+        end
+
+        context 'when all inputs are true' do
+          let(:inputs) { n.times.collect { true } }
+
+          it '= true' do
+            subject.tick
+            subject.tock
+            expect(subject.outputs[0].get).to eq(true)
+          end
+        end
+
+        context 'when all inputs are false' do
+          let(:inputs) { n.times.collect { false } }
+
+          it '= false' do
+            subject.tick
+            subject.tock
+            expect(subject.outputs[0].get).to eq(false)
+          end
+        end
+
+        context 'when any input is false' do
+          n.times do |x|
+            context "when input #{x} is false" do
+              let(:inputs) do
+                inputs =  n.times.collect { true }
+                inputs[x] = false
+                inputs
+              end
+
+              it '= true' do
+                subject.tick
+                subject.tock
+                expect(subject.outputs[0].get).to eq(true)
+              end
+            end
+          end
+        end
+      end
+    end
   end
 end

data/spec/unit/circuits/component/xnor_spec.rb

@@ -55,5 +55,121 @@ describe Circuits::Component::Xnor do
         end
       end
     end
+    context 'when the number of inputs is even' do
+      [2, 4, 8].each do |n|
+        context "with #{n} inputs" do
+          subject { Circuits::Component::Xnor.new inputs: n }
+
+          before do
+            n.times { |x| subject.inputs[x].set inputs[x] }
+          end
+
+          context 'when all inputs are true' do
+            let(:inputs) { n.times.collect { true } }
+
+            it '= true' do
+              subject.tick
+              subject.tock
+              expect(subject.outputs[0].get).to eq(true)
+            end
+          end
+
+          context 'when all inputs are false' do
+            let(:inputs) { n.times.collect { false } }
+
+            it '= true' do
+              subject.tick
+              subject.tock
+              expect(subject.outputs[0].get).to eq(true)
+            end
+          end
+
+          context 'when any input is false' do
+            n.times do |x|
+              context "when input #{x} is false" do
+                let(:inputs) do
+                  inputs =  n.times.collect { true }
+                  inputs[x] = false
+                  inputs
+                end
+
+                it '= false' do
+                  subject.tick
+                  subject.tock
+                  expect(subject.outputs[0].get).to eq(false)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+    context 'when the number of inputs is odd' do
+      [3, 5, 7].each do |n|
+        context "with #{n} inputs" do
+          subject { Circuits::Component::Xnor.new inputs: n }
+
+          before do
+            n.times { |x| subject.inputs[x].set inputs[x] }
+          end
+
+          context 'when all inputs are true' do
+            let(:inputs) { n.times.collect { true } }
+
+            it '= false' do
+              subject.tick
+              subject.tock
+              expect(subject.outputs[0].get).to eq(false)
+            end
+          end
+
+          context 'when all inputs are false' do
+            let(:inputs) { n.times.collect { false } }
+
+            it '= true' do
+              subject.tick
+              subject.tock
+              expect(subject.outputs[0].get).to eq(true)
+            end
+          end
+
+          context 'when any input is false' do
+            n.times do |x|
+              context "when input #{x} is false" do
+                let(:inputs) do
+                  inputs =  n.times.collect { true }
+                  inputs[x] = false
+                  inputs
+                end
+
+                it '= true' do
+                  subject.tick
+                  subject.tock
+                  expect(subject.outputs[0].get).to eq(true)
+                end
+              end
+            end
+          end
+
+          context 'when any input is true' do
+            n.times do |x|
+              context "when input #{x} is true" do
+                let(:inputs) do
+                  inputs =  n.times.collect { false }
+                  inputs[x] = true
+                  inputs
+                end
+
+                it '= false' do
+                  subject.tick
+                  subject.tock
+                  expect(subject.outputs[0].get).to eq(false)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
   end
 end

data/spec/unit/circuits/component/xor_spec.rb

@@ -55,5 +55,121 @@ describe Circuits::Component::Xor do
         end
       end
     end
+    context 'when the number of inputs is even' do
+      [2, 4, 8].each do |n|
+        context "with #{n} inputs" do
+          subject { Circuits::Component::Xor.new inputs: n }
+
+          before do
+            n.times { |x| subject.inputs[x].set inputs[x] }
+          end
+
+          context 'when all inputs are true' do
+            let(:inputs) { n.times.collect { true } }
+
+            it '= false' do
+              subject.tick
+              subject.tock
+              expect(subject.outputs[0].get).to eq(false)
+            end
+          end
+
+          context 'when all inputs are false' do
+            let(:inputs) { n.times.collect { false } }
+
+            it '= false' do
+              subject.tick
+              subject.tock
+              expect(subject.outputs[0].get).to eq(false)
+            end
+          end
+
+          context 'when any input is false' do
+            n.times do |x|
+              context "when input #{x} is false" do
+                let(:inputs) do
+                  inputs =  n.times.collect { true }
+                  inputs[x] = false
+                  inputs
+                end
+
+                it '= true' do
+                  subject.tick
+                  subject.tock
+                  expect(subject.outputs[0].get).to eq(true)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+    context 'when the number of inputs is odd' do
+      [3, 5, 7].each do |n|
+        context "with #{n} inputs" do
+          subject { Circuits::Component::Xor.new inputs: n }
+
+          before do
+            n.times { |x| subject.inputs[x].set inputs[x] }
+          end
+
+          context 'when all inputs are true' do
+            let(:inputs) { n.times.collect { true } }
+
+            it '= true' do
+              subject.tick
+              subject.tock
+              expect(subject.outputs[0].get).to eq(true)
+            end
+          end
+
+          context 'when all inputs are false' do
+            let(:inputs) { n.times.collect { false } }
+
+            it '= false' do
+              subject.tick
+              subject.tock
+              expect(subject.outputs[0].get).to eq(false)
+            end
+          end
+
+          context 'when any input is false' do
+            n.times do |x|
+              context "when input #{x} is false" do
+                let(:inputs) do
+                  inputs =  n.times.collect { true }
+                  inputs[x] = false
+                  inputs
+                end
+
+                it '= false' do
+                  subject.tick
+                  subject.tock
+                  expect(subject.outputs[0].get).to eq(false)
+                end
+              end
+            end
+          end
+
+          context 'when any input is true' do
+            n.times do |x|
+              context "when input #{x} is true" do
+                let(:inputs) do
+                  inputs =  n.times.collect { false }
+                  inputs[x] = true
+                  inputs
+                end
+
+                it '= true' do
+                  subject.tick
+                  subject.tock
+                  expect(subject.outputs[0].get).to eq(true)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
   end
 end

data/spec/unit/circuits/component_spec.rb

@@ -8,17 +8,67 @@ class MockComponent
   def initialize(opts = {})
     @outputs = opts[:outputs]
   end
+
+  def mock_input_count
+    input_count
+  end
+
+  def mock_output_count
+    output_count
+  end
+
+  def mock_create_inputs(n)
+    create_inputs(n)
+  end
 end
 
 describe Circuits::Component do
-  describe '#tock' do
-    let(:outputs) { [double('output')] }
+  let(:outputs) { [double('output')] }
+
+  subject { MockComponent.new(outputs: outputs) }
+
+  describe '#input_count' do
+    it 'is not implemented' do
+      expect { subject.mock_input_count }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe '#output_count' do
+    it 'is not implemented' do
+      expect { subject.mock_output_count }.to raise_error(NotImplementedError)
+    end
+  end
 
-    subject { MockComponent.new(outputs: outputs) }
+  describe '#tick' do
+    it 'is not implemented' do
+      expect { subject.tick }.to raise_error(NotImplementedError)
+    end
+  end
 
+  describe '#tock' do
     it 'tocks the outputs' do
       expect(outputs[0]).to receive(:tock)
       subject.tock
     end
   end
+
+  describe '#create_inputs' do
+    before :each do
+      allow(subject).to receive(:input_count).and_return(2)
+    end
+
+    context 'when the given argument is less than the value of input count' do
+      it 'fails with an argument error' do
+        expect { subject.mock_create_inputs(0) }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'when given a valid number of inputs' do
+      [2, 4, 6].each do |n|
+        it "creates #{n} inputs" do
+          expect(subject.mock_create_inputs(n).size).to eq(n)
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuits
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Henry Muru Paenga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2015-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,48 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.34'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.34'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 description: 
 email:
 - meringu@gmail.com