circuits 0.2.3 → 0.2.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmU5NjYyNWJiYjYyMzY4ZmI5ZWIxMjk5MzU2NDM5N2JmOTNmZDNkZA==
+    NDA3ZjgwZWU3MWRjMjU5NjE5ZjFkNGI5ZTUxOWY5NzNhYzgxOGZmNg==
   data.tar.gz: !binary |-
-    MDcwMTg3NmJhZmE4OGY3ZDM4YWZlYjAwZWRhYzRlZmYwZWNlNzZhZg==
+    MmJjNDdlMmRmNDE0Y2RkZWJiOTBkMGMzYzAyODU0OTkwZjk2OWRlZA==
 SHA512:
   metadata.gz: !binary |-
-    ZDgxYTQ4MGY0M2EyNTU1YzA2ZTllNDBhYjkyN2Q1MzFhNjg5YWNhOWYwYjVm
-    MmM0MTdiNjA4OTIzMmRlNTkwMDg0YmI3NjExMzQ4ZDc0YTQwMGVlYzBhNTM5
-    MmRjNmRkMTdjYmUyNzc1NWVkMjg1ZDUyMTE1MjlmNzg4YjQyNGI=
+    NWZjODc5OGQwYjFhNzgxNTM5OTY5OGFjMjMwNmExZTUzNGRiMjU2OGI2MmQ1
+    MDY5NDI2NDM4NzYxMTU1ZjIxYzRmMTk4NDE4MWRhZjU5YjdjMzI4ODZhYmZl
+    Njc5YjJmOThmZmFjNGQ3MDE1ZmMyNTM0M2I5YzViMDE2MDk4MzI=
   data.tar.gz: !binary |-
-    NGE1MDEzZWRiOTRjMWIzMWRkNjg0MTJmNzA4M2JjNDRiZjVhMzQ3MzcxMWNk
-    Mzg0M2JjZGNiZDgzYWFiOWE0ODY1NDA2ZDViODc5MmExZmQxMzAxMTI5NzA3
-    Mzk3Mzk0MDliZTQ2NmIwM2M5YTYwMDFkM2I5ODgxYzE2YTI2ODk=
+    MzIwZmVkZmQ2YjhkYjIxMTM4MGEwZWE5ZGQ2OWYzZjhlMzFmMjBkMjgzM2Y3
+    MGQyMDFjY2FkM2YxZjMzODMyYmZiYzQ4YTYyMWU1YzBkZjE1ZDYwMzNhMjdh
+    ODU4M2JhNjZhNjFjOGY1NGI5ZDUzMzljMTE2MGMyMmZkMTlhNTY=

data/README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.org/meringu/circuits.svg?branch=master)](https://travis-ci.org/meringu/circuits)
+[![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)
 

data/lib/circuits/component/and.rb

@@ -6,6 +6,13 @@ module Circuits
     class And
       include Component
 
+      # 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 input_count
         2
       end
@@ -13,10 +20,6 @@ module Circuits
       def output_count
         1
       end
-
-      def tick
-        outputs[0].set(inputs.map(&:get).inject(:&))
-      end
     end
   end
 end

data/lib/circuits/component/nand.rb

@@ -6,6 +6,13 @@ module Circuits
     class Nand
       include Component
 
+      # 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 input_count
         2
       end
@@ -13,10 +20,6 @@ module Circuits
       def output_count
         1
       end
-
-      def tick
-        outputs[0].set(!inputs.map(&:get).inject(:&))
-      end
     end
   end
 end

data/lib/circuits/component/nor.rb

@@ -6,6 +6,13 @@ module Circuits
     class Nor
       include Component
 
+      # 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 input_count
         2
       end
@@ -13,10 +20,6 @@ module Circuits
       def output_count
         1
       end
-
-      def tick
-        outputs[0].set(!inputs.map(&:get).inject(:|))
-      end
     end
   end
 end

data/lib/circuits/component/not.rb

@@ -5,18 +5,21 @@ module Circuits
     # Logical NOT Operator
     class Not
       include Component
-
+
+      # 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 input_count
         1
       end
 
       def output_count
         1
-      end
-
-      def tick
-        outputs[0].set(!inputs[0].get)
-      end
+      end
     end
   end
 end

data/lib/circuits/component/or.rb

@@ -6,6 +6,13 @@ module Circuits
     class Or
       include Component
 
+      # 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 input_count
         2
       end
@@ -13,10 +20,6 @@ module Circuits
       def output_count
         1
       end
-
-      def tick
-        outputs[0].set(inputs.map(&:get).inject(:|))
-      end
     end
   end
 end

data/lib/circuits/component/sr_nand.rb

@@ -6,14 +6,7 @@ module Circuits
     class SrNand
       include Component
 
-      def input_count
-        2
-      end
-
-      def output_count
-        2
-      end
-
+      # Computes the outputs based on the inputs and previous state
       def tick
         2.times.each do
           sub_components.each(&:tick)
@@ -27,6 +20,14 @@ module Circuits
 
       attr_reader :nor_1, :nor_2, :sub_components
 
+      def input_count
+        2
+      end
+
+      def output_count
+        2
+      end
+
       def setup
         @nor_1 = Nand.new(inputs: [inputs[0]])
         @nor_2 = Nand.new(inputs: [inputs[1]])

data/lib/circuits/component/sr_nor.rb

@@ -6,14 +6,7 @@ module Circuits
     class SrNor
       include Component
 
-      def input_count
-        2
-      end
-
-      def output_count
-        2
-      end
-
+      # Computes the outputs based on the inputs and previous state
       def tick
         2.times.each do
           sub_components.each(&:tick)
@@ -27,6 +20,14 @@ module Circuits
 
       attr_reader :nor_1, :nor_2, :sub_components
 
+      def input_count
+        2
+      end
+
+      def output_count
+        2
+      end
+
       def setup
         @nor_1 = Nor.new(inputs: [inputs[0]])
         @nor_2 = Nor.new(inputs: [inputs[1]])

data/lib/circuits/component/xnor.rb

@@ -6,6 +6,13 @@ module Circuits
     class Xnor
       include Component
 
+      # 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)
+      end
+
+      private
+
       def input_count
         2
       end
@@ -13,10 +20,6 @@ module Circuits
       def output_count
         1
       end
-
-      def tick
-        outputs[0].set(inputs[0].get == inputs[1].get)
-      end
     end
   end
 end

data/lib/circuits/component/xor.rb

@@ -6,6 +6,13 @@ module Circuits
     class Xor
       include Component
 
+      # 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)
+      end
+
+      private
+
       def input_count
         2
       end
@@ -13,10 +20,6 @@ module Circuits
       def output_count
         1
       end
-
-      def tick
-        outputs[0].set(inputs[0].get != inputs[1].get)
-      end
     end
   end
 end

data/lib/circuits/component.rb

@@ -5,33 +5,40 @@ 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
+  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
     def initialize(opts = {})
       @inputs = opts[:inputs] ||
                 input_count.times.collect { Circuits::Terminal::Input.new }
       @outputs = output_count.times.collect { Circuits::Terminal::Output.new }
       setup
-    end
+    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
 
     attr_reader :inputs, :outputs
-
+
+    private
+
     def input_count
       fail NotImplementedError
     end
-
+
     def output_count
       fail NotImplementedError
     end
-
+
     def setup
-    end
-
-    def tick
-      fail NotImplementedError
-    end
-
-    def tock
-      outputs.each(&:tock)
-    end
+    end
   end
 end

data/lib/circuits/terminal/input.rb

@@ -1,17 +1,26 @@
+require 'circuits/terminal'
+
 module Circuits
   module Terminal
     # Reads from a single output, only assigned to one component
     class Input
+      # Creates the input
+      # @param opts [Hash] Options to create the Input with
+      # @option opts [Component::Output] :output The output to read from
       def initialize(opts = {})
         @output = opts[:output] || Circuits::Terminal::Output.new
       end
 
       attr_accessor :output
 
+      # Forward get to the output
+      # @return [TrueClass, FalseClass] The state of the output
       def get
         output.get
       end
 
+      # Create a new output to use
+      # @param [TrueClass, FalseClass] The state of the output to create
       def set(s)
         @output = Circuits::Terminal::Output.new(state: s)
       end

data/lib/circuits/terminal/output.rb

@@ -1,20 +1,27 @@
+require 'circuits/terminal'
+
 module Circuits
   module Terminal
-    # Owned by a single component, gets set for reading by inputs
+    # Belongs to a single component, gets set for reading by inputs
     class Output
       def initialize(opts = {})
         @next_state = opts[:state] || false
         @state = opts[:state] || false
       end
 
+      # Gets the state of the output
+      # @return [TrueClass, FalseClass] The state of the output
       def get
         state
       end
 
+      # Saves the state
+      # @param [TrueClass, FalseClass] The next desired state of the output
       def set(s)
         @next_state = s
       end
 
+      # Sets the state to be the last state passed by #set
       def tock
         @state = next_state
       end

data/lib/circuits/terminal.rb

@@ -0,0 +1,6 @@
+module Circuits
+  # A terminal holds a logical state, it can be attatched to components
+  module Terminal
+
+  end
+end

data/lib/circuits/version.rb

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

data/spec/unit/circuits/component_spec.rb

@@ -11,26 +11,6 @@ class MockComponent
 end
 
 describe Circuits::Component do
-  subject { MockComponent.new }
-
-  describe '#input_count' do
-    it 'is not implemented' do
-      expect { subject.input_count }.to raise_error(NotImplementedError)
-    end
-  end
-
-  describe '#output_count' do
-    it 'is not implemented' do
-      expect { subject.output_count }.to raise_error(NotImplementedError)
-    end
-  end
-
-  describe '#tick' do
-    it 'is not implemented' do
-      expect { subject.tick }.to raise_error(NotImplementedError)
-    end
-  end
-
   describe '#tock' do
     let(:outputs) { [double('output')] }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuits
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Henry Muru Paenga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-22 00:00:00.000000000 Z
+date: 2015-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,6 +92,7 @@ files:
 - lib/circuits/component/sr_nor.rb
 - lib/circuits/component/xnor.rb
 - lib/circuits/component/xor.rb
+- lib/circuits/terminal.rb
 - lib/circuits/terminal/input.rb
 - lib/circuits/terminal/output.rb
 - lib/circuits/version.rb