circuits 0.4.3 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTFhZjhiMjI3ODFkN2IzMmUyOGUwMGFkYjBiZTJhZmQ3YjVmMDhkOA==
+    YzIxYzBlMDM5ZmJjYjliOWZkODEwM2QxNGUwYmE5ZGIxMWZlYzFkZg==
   data.tar.gz: !binary |-
-    M2RkOGE5YjkwOWNhNjA5NzcxOWM0ZTc4OTNiYTAxZDk2YTcxZmFmYg==
+    Y2E3NDYzMjVmMWY3OWI4MjliZmE5NTRlMTIyMDAwZTRmMGM5ZjNhZg==
 SHA512:
   metadata.gz: !binary |-
-    NWExY2I5NGI4NDEyZGM4ZDFhZmY0NjdmYzM5OWIxYWY0Y2IwYWNlMTg5NjRj
-    YjJlYzFiMDYxZmFlZjdmMzIwY2I1ZWQ0MmJmZGJkMDZlYTFkNTZmMjk2YjVk
-    NmRmNGNhZDU2Y2YzYTE0Y2JhNGE2MTgxNjIwODgzY2Q3ZTIxYzk=
+    MTJhMDdmNzE2ZDYyMjAzYjkyMGJlMmRkNmNhYjc4NTZhMzliYmM1MzZiNjdh
+    OGUwMzY2ZWM0OThjYTQyNDIwYTZmOWMxYTdlOTA3ODAwZDhiZjI2NmE0NjEy
+    ZTA1MDg2MTE4NmMyMWI2YTgzYzhjMzRiNmQzOTY4MGZhNTM5YjM=
   data.tar.gz: !binary |-
-    N2E3YjI0MjkyYjBjN2I0YjA0NTZjYjVkMmM3ZGRhMWNlODNkOTIwNzJlMTdm
-    OTgwMGJjNDBjYWMyZjhhOTIxZDcwNDNjNDM1YzkyY2U5NmJhNTJiNTI4ZmEw
-    YzExMTc5MTM5MWRmNDQzYzhkMTA3NTA4YTk2OTcwZTc5YjE4NGI=
+    MjM5YzM1OTE2MTZlZDc4ZjdlNDI1ODgzNTkxNmUxZWVjYjgyNGFkNDU4Yjlh
+    MTZiNjY0MDM5OGJlMzRiNjc0ZjU3YjM5MzU3NzM5ZWQyNDVmZTE2ZjRlYTdl
+    MDVhZjViYjc2MTlhNTc5ZWU1NGYzM2E5YzYzMGIxMDI5MmYyZDM=

data/lib/circuits/component/and.rb

@@ -1,22 +1,19 @@
-require 'circuits/component'
+require 'circuits/component/base'
 
 module Circuits
   module Component
     # Logical AND Operator
-    class And
-      include Component
+    class And < Base
+      def initialize(opts = {})
+        @input_count = 2
+        @output_count = 1
+        super opts
+      end
 
       # Sets the output to be the result of a logical AND of the inputs
       def tick
         outputs[0].set(inputs.map(&:get).inject(:&))
       end
-
-      private
-
-      def set_defaults
-        @input_count = 2
-        @output_count = 1
-      end
     end
   end
 end

data/lib/circuits/component/base.rb

@@ -0,0 +1,114 @@
+require 'circuits/terminal/input'
+require 'circuits/terminal/output'
+
+module Circuits
+  # A component has a set of inputs an outputs. Every `tick` a componnent
+  # computes its outputs, but the componnent will wait for the `tock` before the
+  # componnent updates its own outputs
+  module Component
+    # Base class to extend
+    class Base
+      # Creates the Component with inputs and outputs
+      # @param opts [Hash] options to create the Component with
+      # @option opts [Array<Input>, FixNum] :inputs The array of inputs to use,
+      # or the number of inputs to create
+      def initialize(opts = {})
+        create_inputs opts
+        create_outputs opts
+      end
+
+      # Does the internal computation and sets the outputs
+      def tick
+        fail NotImplementedError
+      end
+
+      # Sets all the outputs expose what was set in #tick
+      def tock
+        outputs.each(&:tock)
+      end
+
+      # Gets the teminal assigned to the port
+      # @param port [Symbol] The symbol that represents the terminal
+      # @return [Input, Output] The terminal
+      def [](port)
+        p = port_mappings[port]
+        case p[:type]
+        when :input
+          inputs[p[:number]]
+        when :output
+          outputs[p[:number]]
+        end
+      end
+
+      # Assigns to an input or output
+      # @param port [Symbol] The symbol that represents the terminal
+      # @param terminal [Input, Output] The terminal to assign
+      # @return [Input, Output] The terminal that was passed in
+      def []=(port, terminal)
+        p = port_mappings[port]
+        case p[:type]
+        when :input
+          inputs[p[:number]] = terminal
+        when :output
+          outputs[p[:number]] = terminal
+        end
+      end
+
+      # the inputs of this component
+      attr_reader :inputs
+
+      # the outputs of this component
+      attr_reader :outputs
+
+      private
+
+      def create_inputs(opts)
+        if opts[:inputs].class == Array
+          @inputs = opts[:inputs]
+          @input_count = @inputs.length
+        elsif opts[:inputs].class == Fixnum
+          @input_count = opts[:inputs]
+        end
+        @inputs ||= @input_count.times.collect { Circuits::Terminal::Input.new }
+      end
+
+      def create_outputs(opts)
+        if opts[:outputs].class == Array
+          @outputs = opts[:outputs]
+          @output_count = @outputs.length
+        elsif opts[:outputs].class == Fixnum
+          @output_count = opts[:outputs]
+        end
+        @outputs ||= @output_count.times.collect do
+          Circuits::Terminal::Output.new
+        end
+      end
+
+      def port_mappings
+        return @port_mappings unless @port_mappings.nil?
+        @port_mappings = {}
+        input_mappings.each { |x| @port_mappings.merge!(x) }
+        output_mappings.each { |x| @port_mappings.merge!(x) }
+        @port_mappings
+      end
+
+      def input_mappings
+        return [{ in: { type: :input, number: 0 } }] if @input_count == 1
+        @input_count.times.collect do |i|
+          { num_to_port(i) => { type: :input, number: i } }
+        end
+      end
+
+      def output_mappings
+        return[{ out: { type: :output, number: 0 } }] if @output_count == 1
+        @output_count.times.collect do |i|
+          { num_to_port(i + @input_count) => { type: :output, number: i } }
+        end
+      end
+
+      def num_to_port(i)
+        (i + 'a'.ord).chr.to_sym
+      end
+    end
+  end
+end

data/lib/circuits/component/nand.rb

@@ -1,22 +1,19 @@
-require 'circuits/component'
+require 'circuits/component/base'
 
 module Circuits
   module Component
     # Logical NAND Operator
-    class Nand
-      include Component
+    class Nand < Base
+      def initialize(opts = {})
+        @input_count = 2
+        @output_count = 1
+        super opts
+      end
 
       # Sets the output to be the result of a logical NAND of the inputs
       def tick
         outputs[0].set(!inputs.map(&:get).inject(:&))
       end
-
-      private
-
-      def set_defaults
-        @input_count = 2
-        @output_count = 1
-      end
     end
   end
 end

data/lib/circuits/component/nor.rb

@@ -1,22 +1,19 @@
-require 'circuits/component'
+require 'circuits/component/base'
 
 module Circuits
   module Component
     # Logical NOR Operator
-    class Nor
-      include Component
+    class Nor < Base
+      def initialize(opts = {})
+        @input_count = 2
+        @output_count = 1
+        super opts
+      end
 
       # Sets the output to be the result of a logical OR of the inputs
       def tick
         outputs[0].set(!inputs.map(&:get).inject(:|))
       end
-
-      private
-
-      def set_defaults
-        @input_count = 2
-        @output_count = 1
-      end
     end
   end
 end

data/lib/circuits/component/not.rb

@@ -1,22 +1,19 @@
-require 'circuits/component'
+require 'circuits/component/base'
 
 module Circuits
   module Component
     # Logical NOT Operator
-    class Not
-      include Component
+    class Not < Base
+      def initialize(opts = {})
+        @input_count = 1
+        @output_count = 1
+        super opts
+      end
 
       # Sets the output to be the result of a logical NOT of the inputs
       def tick
         outputs[0].set(!inputs[0].get)
       end
-
-      private
-
-      def set_defaults
-        @input_count = 1
-        @output_count = 1
-      end
     end
   end
 end

data/lib/circuits/component/or.rb

@@ -1,22 +1,19 @@
-require 'circuits/component'
+require 'circuits/component/base'
 
 module Circuits
   module Component
     # Logical OR Operator
-    class Or
-      include Component
+    class Or < Base
+      def initialize(opts = {})
+        @input_count = 2
+        @output_count = 1
+        super opts
+      end
 
       # Sets the output to be the result of a logical OR of the inputs
       def tick
         outputs[0].set(inputs.map(&:get).inject(:|))
       end
-
-      private
-
-      def set_defaults
-        @input_count = 2
-        @output_count = 1
-      end
     end
   end
 end

data/lib/circuits/component/sr_nand.rb

@@ -1,14 +1,19 @@
-require 'circuits/component'
+require 'circuits/component/base'
 
 module Circuits
   module Component
     # SR NAND Latch
-    class SrNand
-      include Component
+    class SrNand < Base
+      def initialize(opts = {})
+        set_defaults
+        super opts
+        create_sub_components
+        link_sub_components
+      end
 
       # Computes the outputs based on the inputs and previous state
       def tick
-        update_internal_components
+        update_sub_components
         self[:q].set nand_1[:out].get
         self[:not_q].set nand_2[:out].get
       end
@@ -17,13 +22,13 @@ module Circuits
 
       attr_reader :nand_1, :nand_2, :sub_components
 
-      def create_internal_components
+      def create_sub_components
         @nand_1 = Nand.new
         @nand_2 = Nand.new
         @sub_components = [@nand_1, @nand_2]
       end
 
-      def link_internal_components
+      def link_sub_components
         nand_1[:a] = self[:not_s]
         nand_2[:a] = self[:not_r]
         nand_1[:b] = nand_2[:out]
@@ -41,12 +46,7 @@ module Circuits
         }
       end
 
-      def setup
-        create_internal_components
-        link_internal_components
-      end
-
-      def update_internal_components
+      def update_sub_components
         2.times.each do
           sub_components.each(&:tick)
           sub_components.each(&:tock)

data/lib/circuits/component/sr_nor.rb

@@ -1,10 +1,15 @@
-require 'circuits/component'
+require 'circuits/component/base'
 
 module Circuits
   module Component
     # SR NOR Latch
-    class SrNor
-      include Component
+    class SrNor < Base
+      def initialize(opts = {})
+        set_defaults
+        super opts
+        create_internal_components
+        link_internal_components
+      end
 
       # Computes the outputs based on the inputs and previous state
       def tick
@@ -41,11 +46,6 @@ module Circuits
         }
       end
 
-      def setup
-        create_internal_components
-        link_internal_components
-      end
-
       def update_internal_components
         2.times.each do
           sub_components.each(&:tick)

data/lib/circuits/component/xnor.rb

@@ -1,22 +1,19 @@
-require 'circuits/component'
+require 'circuits/component/base'
 
 module Circuits
   module Component
     # Logical XNOR Operator
-    class Xnor
-      include Component
+    class Xnor < Base
+      def initialize(opts = {})
+        @input_count = 2
+        @output_count = 1
+        super opts
+      end
 
       # Sets the output to be the result of a logical XNOR of the inputs
       def tick
         outputs[0].set(!inputs.map(&:get).inject(:^))
       end
-
-      private
-
-      def set_defaults
-        @input_count = 2
-        @output_count = 1
-      end
     end
   end
 end

data/lib/circuits/component/xor.rb

@@ -1,22 +1,19 @@
-require 'circuits/component'
+require 'circuits/component/base'
 
 module Circuits
   module Component
     # Logical XOR Operator
-    class Xor
-      include Component
+    class Xor < Base
+      def initialize(opts = {})
+        @input_count = 2
+        @output_count = 1
+        super opts
+      end
 
       # Sets the output to be the result of a logical XOR of the inputs
       def tick
         outputs[0].set(inputs.map(&:get).inject(:^))
       end
-
-      private
-
-      def set_defaults
-        @input_count = 2
-        @output_count = 1
-      end
     end
   end
 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.4.3'
+  VERSION = '0.5.0'
 end

data/spec/unit/circuits/{component_spec.rb → component/base_spec.rb}

@@ -1,114 +1,102 @@
-require 'spec_helper'
-require 'circuits/component'
-
-# Mock component to include Circuits::Component for function accessability
-class MockComponent1
-  include Circuits::Component
-
-  def set_defaults
-    @input_count = 1
-    @output_count = 1
-  end
-end
-
-# Mock component to include Circuits::Component for function accessability
-class MockComponent2
-  include Circuits::Component
-end
-
-describe Circuits::Component do
-  context 'when using defaults' do
-    subject { MockComponent1.new }
-
-    it 'has one input' do
-      expect(subject.inputs.count).to eq(1)
-    end
-
-    it 'has one output' do
-      expect(subject.outputs.count).to eq(1)
-    end
-
-    describe '#[]=' do
-      let(:new_input) { double('new_input') }
-      let(:new_output) { double('new_output') }
-
-      before do
-        subject[:in] = new_input
-        subject[:out] = new_output
-      end
-
-      it 'has the new input available as :in' do
-        expect(subject[:in]).to eq(new_input)
-      end
-
-      it 'has the new output available as :out' do
-        expect(subject[:out]).to eq(new_output)
-      end
-    end
-  end
-
-  context 'when specifying input and output count' do
-    subject { MockComponent1.new(inputs: 2, outputs: 2) }
-
-    it 'has one input' do
-      expect(subject.inputs.count).to eq(2)
-    end
-
-    it 'has one output' do
-      expect(subject.outputs.count).to eq(2)
-    end
-  end
-
-  context 'when supplying inputs and outputs' do
-    let(:inputs) { [double('input')] }
-    let(:outputs) { [double('output')] }
-
-    subject { MockComponent1.new(inputs: inputs, outputs: outputs) }
-
-    describe '#tick' do
-      it 'raises NotImplementedError' 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 '#[]' do
-      context 'one input and one output' do
-        it 'has the input available as :in' do
-          expect(subject[:in]).to eq(inputs[0])
-        end
-
-        it 'has the output available as :out' do
-          expect(subject[:out]).to eq(outputs[0])
-        end
-      end
-
-      context 'two inputs and two outputs' do
-        let(:inputs) { [double('input_1'), double('input_2')] }
-        let(:outputs) { [double('output_1'), double('output_2')] }
-
-        it 'has the inputs available as :a and :b' do
-          expect(subject[:a]).to eq(inputs[0])
-          expect(subject[:b]).to eq(inputs[1])
-        end
-
-        it 'has the outputs available as :c and :d' do
-          expect(subject[:c]).to eq(outputs[0])
-          expect(subject[:d]).to eq(outputs[1])
-        end
-      end
-    end
-  end
-
-  context 'when you do not override #set_defaults' do
-    it 'raises NotImplementedError' do
-      expect { MockComponent2.new }.to raise_error(NotImplementedError)
-    end
-  end
-end
+require 'spec_helper'
+require 'circuits/component/base'
+
+# Mock component to include Circuits::Component::Base
+class MockComponent < Circuits::Component::Base
+  def initialize(opts = {})
+    @input_count = 1
+    @output_count = 1
+    super opts
+  end
+end
+
+describe Circuits::Component::Base do
+  context 'when using defaults' do
+    subject { MockComponent.new }
+
+    it 'has one input' do
+      expect(subject.inputs.count).to eq(1)
+    end
+
+    it 'has one output' do
+      expect(subject.outputs.count).to eq(1)
+    end
+
+    describe '#[]=' do
+      let(:new_input) { double('new_input') }
+      let(:new_output) { double('new_output') }
+
+      before do
+        subject[:in] = new_input
+        subject[:out] = new_output
+      end
+
+      it 'has the new input available as :in' do
+        expect(subject[:in]).to eq(new_input)
+      end
+
+      it 'has the new output available as :out' do
+        expect(subject[:out]).to eq(new_output)
+      end
+    end
+  end
+
+  context 'when specifying input and output count' do
+    subject { MockComponent.new(inputs: 2, outputs: 2) }
+
+    it 'has one input' do
+      expect(subject.inputs.count).to eq(2)
+    end
+
+    it 'has one output' do
+      expect(subject.outputs.count).to eq(2)
+    end
+  end
+
+  context 'when supplying inputs and outputs' do
+    let(:inputs) { [double('input')] }
+    let(:outputs) { [double('output')] }
+
+    subject { MockComponent.new(inputs: inputs, outputs: outputs) }
+
+    describe '#tick' do
+      it 'raises NotImplementedError' 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 '#[]' do
+      context 'one input and one output' do
+        it 'has the input available as :in' do
+          expect(subject[:in]).to eq(inputs[0])
+        end
+
+        it 'has the output available as :out' do
+          expect(subject[:out]).to eq(outputs[0])
+        end
+      end
+
+      context 'two inputs and two outputs' do
+        let(:inputs) { [double('input_1'), double('input_2')] }
+        let(:outputs) { [double('output_1'), double('output_2')] }
+
+        it 'has the inputs available as :a and :b' do
+          expect(subject[:a]).to eq(inputs[0])
+          expect(subject[:b]).to eq(inputs[1])
+        end
+
+        it 'has the outputs available as :c and :d' do
+          expect(subject[:c]).to eq(outputs[0])
+          expect(subject[:d]).to eq(outputs[1])
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circuits
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Henry Muru Paenga
@@ -124,8 +124,8 @@ files:
 - Rakefile
 - circuits.gemspec
 - lib/circuits.rb
-- lib/circuits/component.rb
 - lib/circuits/component/and.rb
+- lib/circuits/component/base.rb
 - lib/circuits/component/nand.rb
 - lib/circuits/component/nor.rb
 - lib/circuits/component/not.rb
@@ -140,6 +140,7 @@ files:
 - lib/circuits/version.rb
 - spec/spec_helper.rb
 - spec/unit/circuits/component/and_spec.rb
+- spec/unit/circuits/component/base_spec.rb
 - spec/unit/circuits/component/nand_spec.rb
 - spec/unit/circuits/component/nor_spec.rb
 - spec/unit/circuits/component/not_spec.rb
@@ -148,7 +149,6 @@ files:
 - spec/unit/circuits/component/sr_nor_spec.rb
 - spec/unit/circuits/component/xnor_spec.rb
 - spec/unit/circuits/component/xor_spec.rb
-- spec/unit/circuits/component_spec.rb
 - spec/unit/circuits/terminal/input_spec.rb
 - spec/unit/circuits/terminal/output_spec.rb
 homepage: https://github.com/meringu/circuits
@@ -178,6 +178,7 @@ summary: Express logical circuits in code
 test_files:
 - spec/spec_helper.rb
 - spec/unit/circuits/component/and_spec.rb
+- spec/unit/circuits/component/base_spec.rb
 - spec/unit/circuits/component/nand_spec.rb
 - spec/unit/circuits/component/nor_spec.rb
 - spec/unit/circuits/component/not_spec.rb
@@ -186,6 +187,5 @@ test_files:
 - spec/unit/circuits/component/sr_nor_spec.rb
 - spec/unit/circuits/component/xnor_spec.rb
 - spec/unit/circuits/component/xor_spec.rb
-- spec/unit/circuits/component_spec.rb
 - spec/unit/circuits/terminal/input_spec.rb
 - spec/unit/circuits/terminal/output_spec.rb

data/lib/circuits/component.rb

@@ -1,121 +0,0 @@
-require 'circuits/terminal/input'
-require 'circuits/terminal/output'
-
-module Circuits
-  # A component has a set of inputs an outputs. Every `tick` a componnent
-  # computes its outputs, but the componnent will wait for the `tock` before the
-  # componnent updates its own outputs
-  module Component
-    # Creates the Component with inputs and outputs
-    # @param opts [Hash] options to create the Component with
-    # @option opts [Array<Input>, FixNum] :inputs The array of inputs to use, or
-    #   the number of inputs to create
-    def initialize(opts = {})
-      set_defaults
-      create_inputs opts
-      create_outputs opts
-      create_port_mappings
-      setup
-    end
-
-    # Does the internal computation and sets the outputs
-    def tick
-      fail NotImplementedError
-    end
-
-    # Sets all the outputs expose what was set in #tick
-    def tock
-      outputs.each(&:tock)
-    end
-
-    # Gets the teminal assigned to the port
-    # @param port [Symbol] The symbol that represents the terminal
-    # @return [Input, Output] The terminal
-    def [](port)
-      p = @port_mappings[port]
-      case p[:type]
-      when :input
-        @inputs[p[:number]]
-      when :output
-        @outputs[p[:number]]
-      end
-    end
-
-    # Assigns to an input or output
-    # @param port [Symbol] The symbol that represents the terminal
-    # @param terminal [Input, Output] The terminal to assign
-    # @return [Input, Output] The terminal that was passed in
-    def []=(port, terminal)
-      p = @port_mappings[port]
-      case p[:type]
-      when :input
-        @inputs[p[:number]] = terminal
-      when :output
-        @outputs[p[:number]] = terminal
-      end
-    end
-
-    # the inputs of this component
-    attr_reader :inputs
-
-    # the outputs of this component
-    attr_reader :outputs
-
-    private
-
-    def create_inputs(opts)
-      if opts[:inputs].class == Array
-        @inputs = opts[:inputs]
-        @input_count = @inputs.length
-      elsif opts[:inputs].class == Fixnum
-        @input_count = opts[:inputs]
-      end
-      @inputs ||= @input_count.times.collect { Circuits::Terminal::Input.new }
-    end
-
-    def create_outputs(opts)
-      if opts[:outputs].class == Array
-        @outputs = opts[:outputs]
-        @output_count = @outputs.length
-      elsif opts[:outputs].class == Fixnum
-        @output_count = opts[:outputs]
-      end
-      @outputs ||= @output_count.times.collect do
-        Circuits::Terminal::Output.new
-      end
-    end
-
-    def create_port_mappings
-      return @port_mappings unless @port_mappings.nil?
-      @port_mappings = {}
-      input_mappings.each { |x| @port_mappings.merge!(x) }
-      output_mappings.each { |x| @port_mappings.merge!(x) }
-      @port_mappings
-    end
-
-    def input_mappings
-      return [{ in: { type: :input, number: 0 } }] if @input_count == 1
-      @input_count.times.collect do |i|
-        { num_to_port(i) => { type: :input, number: i } }
-      end
-    end
-
-    def output_mappings
-      return[{ out: { type: :output, number: 0 } }] if @output_count == 1
-      @output_count.times.collect do |i|
-        { num_to_port(i + @input_count) => { type: :output, number: i } }
-      end
-    end
-
-    def num_to_port(i)
-      (i + 'a'.ord).chr.to_sym
-    end
-
-    def set_defaults
-      fail NotImplementedError
-    end
-
-    def setup
-    end
-  end
-end