obvious 0.0.10 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bf4de686eee48c524a3037620e21a154db8c75fce3ff8db780afc25dc376202
+  data.tar.gz: c4930e55f1420a9b40996fc042052f267548b3f6017055ad69355c44bad28f7e
+SHA512:
+  metadata.gz: 377a83eba55eeadeb63bdadd1a12f72a81507b5d029486add3ffba65fd81c4de929936e435bc73ac0816185bab6dff2a0aa1b4ecfcf527fa36d4dbdc13abaf81
+  data.tar.gz: 6f7a51c4037baa95be253c62a801f1c8204e662b089bc45bd7f6db1df94f6c39d1130625fb745a7c558111662c5baeaf59372817a077f17d14faf7af2ce0b394

data/.github/workflows/obvious.yml

@@ -0,0 +1,19 @@
+name: obvious
+
+on: [push]
+
+jobs:
+  unit-tests:
+    strategy:
+      matrix:
+        ruby: [ 2.7, '3.0', 3.1 ]
+    name: Ruby ${{ matrix.ruby }} unit tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: |
+          bundle exec rspec

data/.gitignore

@@ -4,7 +4,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    obvious (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  obvious!
+  rspec
+
+BUNDLED WITH
+   2.3.4

data/README.md

@@ -6,6 +6,16 @@ independent of the app logic itself.
 
 You can get a full explanation of Obvious at http://obvious.retromocha.com
 
+
+# Notice:
+
+This project is no longer under active development is only made available for historical purposes.
+
+Right now [Brian is working on a little of this](http://brianknapp.me/now/) and [Shawn is working on a little of that](http://shawnbaden.com/now/).
+
+Most of our spare energy goes to the [Unbranded Pocket Notebook](https://www.amazon.com/dp/B00ZGE1914/) and the [Unbranded Pocket Journal](https://www.amazon.com/dp/B016LB2XYW).
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -35,11 +45,3 @@ in the Obvious Status example app: https://github.com/RetroMocha/obvious_status.
 Currently the footprint of the Obvious library is quite small. The most important things defined so far are the Contract class
 and the Hash.has_shape? method. The rest of what makes an Obvious app interesting is the structure itself, not the libraries Obvious
 provides.
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/lib/generators/application_generator.rb

@@ -146,7 +146,7 @@ end
 
             output = %Q{require 'obvious'
 
-class #{k}Contract < Contract
+class #{k}Contract < Obvious::Contract
   #{contract_defs}
 end
 }

data/lib/obvious/contract.rb

@@ -1,157 +1,161 @@
-class Contract
-  @@disable_override = false
+module Obvious
 
-  # Provides a default empty array for method_added
-  # Overriden by self.contracts
-  def self.contract_list
-    []
-  end
+  class Contract
+    @@disable_override = false
 
-  # Public: Sets the contracts
-  #
-  # contracts - a list of contracts, as String or as Symbols.
-  #
-  # Examples
-  #
-  #   class FooJackContract < Contract
-  #     contracts :save, :get, :list
-  #
-  #   end
-  #
-  # Returns Nothing.
-  def self.contracts *contracts
-    singleton_class.send :define_method, :contract_list do
-      contracts
+    # Provides a default empty array for method_added
+    # Overriden by self.contracts
+    def self.contract_list
+      []
     end
-  end
 
-  # Public: Defines a contract for a method
-  #
-  # method - a symbol representing the method name
-  # contract - a hash with the keys :input and :output holding the respective shapes.
-  #
-  # Examples
-  #
-  #   class FooJackContract < Contract
-  #
-  #     contract_for :save, {
-  #       :input  => Foo.shape,
-  #       :output => Foo.shape,
-  #     }
-  #
-  #   end
-  #
-  def self.contract_for method, contract
-    method_alias    = "#{method}_alias".to_sym
-    method_contract = "#{method}_contract".to_sym
-
-    define_method method_contract do |*args|
-      input = args[0]
-      call_method method_alias, input, contract[:input], contract[:output]
-    end
-
-    contracts( *contract_list, method )
-  end
-
-  # This method will move methods defined in @contracts into new methods.
-  # Each entry in @contracts will cause the method with the same name to
-  # become method_name_alias and for the original method to point to
-  # method_name_contract.
-  def self.method_added name
-    unless @@disable_override
-      self.contract_list.each do |method|
-        if name == method.to_sym
-          method_alias = "#{method}_alias".to_sym
-          method_contract = "#{method}_contract".to_sym
-
-          @@disable_override = true # to stop the new build method
-          self.send :alias_method, method_alias, name
-          self.send :remove_method, name
-          self.send :alias_method, name, method_contract
-
-          @@disable_override = false
-        else
-          # puts self.inspect
-          # puts "defining other method #{name}"
-        end
+    # Public: Sets the contracts
+    #
+    # contracts - a list of contracts, as String or as Symbols.
+    #
+    # Examples
+    #
+    #   class FooJackContract < Contract
+    #     contracts :save, :get, :list
+    #
+    #   end
+    #
+    # Returns Nothing.
+    def self.contracts *contracts
+      singleton_class.send :define_method, :contract_list do
+        contracts
       end
     end
-  end
 
-  # This method is used as a shorthand to mak the contract method calling pattern more DRY
-  # It starts by checking if you are sending in input and if so will check the input shape for
-  # errors. If no errors are found it calls the method via the passed in symbol(method).
-  #
-  # Output checking is more complicated because of the types of output we check for. Nil is
-  # never valid output. If we pass in the output shape of true, that means we are looking for
-  # result to be the object True. If the output shape is an array, that is actually a shorthand
-  # for telling our output check to look at the output as an array and compare it to the shape
-  # stored in output_shape[0]. If we pass in the symbol :true_false it means we are looking for
-  # the result to be either true or false. The default case will just check if result has the shape
-  # of the output_shape.
-  def call_method method, input, input_shape, output_shape
-    if input != nil && input_shape != nil
-      has_shape, error_field = input.has_shape? input_shape, true
-      unless has_shape 
-        raise ContractInputError, "incorrect input data format field #{error_field}"
+    # Public: Defines a contract for a method
+    #
+    # method - a symbol representing the method name
+    # contract - a hash with the keys :input and :output holding the respective shapes.
+    #
+    # Examples
+    #
+    #   class FooJackContract < Contract
+    #
+    #     contract_for :save, {
+    #       :input  => Foo.shape,
+    #       :output => Foo.shape,
+    #     }
+    #
+    #   end
+    #
+    def self.contract_for method, contract
+      method_alias    = "#{method}_alias".to_sym
+      method_contract = "#{method}_contract".to_sym
+
+      define_method method_contract do |*args|
+        input = args[0]
+        call_method method_alias, input, contract[:input], contract[:output]
       end
 
-      result = self.send method, input
-    else
-      result = self.send method
+      contracts( *contract_list, method )
     end
 
-    # check output
-    # output should never be nil
-    if result == nil
-      raise ContractOutputError, 'incorrect output data format'
+    # This method will move methods defined in @contracts into new methods.
+    # Each entry in @contracts will cause the method with the same name to
+    # become method_name_alias and for the original method to point to
+    # method_name_contract.
+    def self.method_added name
+      unless @@disable_override
+        self.contract_list.each do |method|
+          if name == method.to_sym
+            method_alias = "#{method}_alias".to_sym
+            method_contract = "#{method}_contract".to_sym
+
+            @@disable_override = true # to stop the new build method
+            self.send :alias_method, method_alias, name
+            self.send :remove_method, name
+            self.send :alias_method, name, method_contract
+
+            @@disable_override = false
+          else
+            # puts self.inspect
+            # puts "defining other method #{name}"
+          end
+        end
+      end
     end
 
-    if result === {}
-      raise DataNotFoundError, 'data was not found'
-    end
+    # This method is used as a shorthand to mak the contract method calling pattern more DRY
+    # It starts by checking if you are sending in input and if so will check the input shape for
+    # errors. If no errors are found it calls the method via the passed in symbol(method).
+    #
+    # Output checking is more complicated because of the types of output we check for. Nil is
+    # never valid output. If we pass in the output shape of true, that means we are looking for
+    # result to be the object True. If the output shape is an array, that is actually a shorthand
+    # for telling our output check to look at the output as an array and compare it to the shape
+    # stored in output_shape[0]. If we pass in the symbol :true_false it means we are looking for
+    # the result to be either true or false. The default case will just check if result has the shape
+    # of the output_shape.
+    def call_method method, input, input_shape, output_shape
+      if input != nil && input_shape != nil
+        has_shape, error_field = input.has_shape? input_shape, true
+        unless has_shape 
+          raise ContractInputError, "incorrect input data format field #{error_field}"
+        end
 
-    # we are looking for result to be a True object
-    if output_shape === true
-      if output_shape == result
-        return result
+        result = self.send method, input
       else
+        result = self.send method
+      end
+
+      # check output
+      # output should never be nil
+      if result == nil
         raise ContractOutputError, 'incorrect output data format'
       end
-    end
 
-    # we want to check the shape of each item in the result array
-    if output_shape.class == Array
-      if result.class == Array
-        inner_shape = output_shape[0]
-        result.each do |item|
-          has_shape, error_field = item.has_shape? inner_shape, true
-          unless has_shape 
-            raise ContractOutputError, "incorrect output data format field #{error_field}"
+      if result === {}
+        raise DataNotFoundError, 'data was not found'
+      end
+
+      # we are looking for result to be a True object
+      if output_shape === true
+        if output_shape == result
+          return result
+        else
+          raise ContractOutputError, 'incorrect output data format'
+        end
+      end
+
+      # we want to check the shape of each item in the result array
+      if output_shape.class == Array
+        if result.class == Array
+          inner_shape = output_shape[0]
+          result.each do |item|
+            has_shape, error_field = item.has_shape? inner_shape, true
+            unless has_shape 
+              raise ContractOutputError, "incorrect output data format field #{error_field}"
+            end
           end
+
+          return result
+        end
+        raise ContractOutputError, 'incorrect output data format'
+      end
+
+      # we want result to be true or false
+      if output_shape == :true_false
+        unless result == true || result == false
+          raise ContractOutputError, 'incorrect output data format'
         end
 
         return result
       end
-      raise ContractOutputError, 'incorrect output data format'
-    end
 
-    # we want result to be true or false
-    if output_shape == :true_false
-      unless result == true || result == false
-        raise ContractOutputError, 'incorrect output data format'
+      # we want result to be output_shape's shape
+      has_shape, error_field = result.has_shape? output_shape, true
+      unless has_shape 
+        raise ContractOutputError, "incorrect output data format field #{error_field}"
       end
 
-      return result
-    end
-
-    # we want result to be output_shape's shape
-    has_shape, error_field = result.has_shape? output_shape, true
-    unless has_shape 
-      raise ContractOutputError, "incorrect output data format field #{error_field}"
+      result
     end
 
-    result
   end
 
 end
@@ -160,7 +164,7 @@ end
 class Hash
   # Checks if a hash has a certain structure.
   #     h = { k1: 1, k2: "1" }
-  #     h.has_shape?(k1: Fixnum, k2: String)
+  #     h.has_shape?(k1: Integer, k2: String)
   #     #=> true
   #     h.has_shape?(k1: Class, k2: String)
   #     #=> false

data/lib/obvious/version.rb

@@ -1,3 +1,3 @@
 module Obvious
-  VERSION = "0.0.10"
+  VERSION = "0.1.0"
 end

data/obvious.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Brian Knapp"]
   gem.email         = ["brianknapp@gmail.com"]
   gem.description   = "A set of tools to build apps using the Obvious Architecture"
-  gem.summary       = "Isn't it Obvious?"
+  gem.summary       = "Clean Architecture framework"
   gem.homepage      = "http://obvious.retromocha.com/"
 
   gem.files         = `git ls-files`.split($/)

data/spec/contract_spec.rb

@@ -5,27 +5,27 @@ require_relative '../lib/obvious/contract'
 describe Hash do
   describe '#has_shape?' do
     it 'should return true for a valid shape' do
-      { id: 1 }.has_shape?(id: Fixnum).should be true
+      expect({ id: 1 }.has_shape?(id: Integer)).to be true
     end
     
     it 'should return false for an invalid shape' do
-      { id: 1 }.has_shape?(id: String).should be false
+      expect({ id: 1 }.has_shape?(id: String)).to be false
     end
 
     it 'should retrn the invalid field if return_field flag is set' do
-      { id: 1 }.has_shape?({id: String}, true).should eq [false, :id]
+      expect({ id: 1 }.has_shape?({id: String}, true)).to eq [false, :id]
     end
 
     it 'should allow for nil values to be returned' do
-      { id: nil }.has_shape?({id: String}).should be true
+      expect({ id: nil }.has_shape?({id: String})).to be true
     end 
   end
 end
 
-class TestContract < Contract
+class TestContract < Obvious::Contract
   contract_for :test, {
-    input: { id: Fixnum },
-    output: { id: Fixnum, value: String }
+    input: { id: Integer },
+    output: { id: Integer, value: String }
   }
 
   def test input
@@ -33,13 +33,13 @@ class TestContract < Contract
   end
 end
 
-describe Contract do
+describe Obvious::Contract do
 
   describe "#call_method" do
     it 'should return the correct output for valid input and output shapes' do
       tc = TestContract.new
       result = tc.test id: 1
-      result.should eq id: 1, value: 'this is a test'
+      expect(result).to eq id: 1, value: 'this is a test'
     end
   
     it 'should raise a contract input error with bad input' do
@@ -49,13 +49,13 @@ describe Contract do
 
     it 'should raise a DataNotFound error if {} is returned' do
       tc = TestContract.new
-      tc.should_receive(:test_alias).and_return({}) 
+      allow(tc).to receive(:test_alias).and_return({}) 
       expect { tc.test id: 1 }.to raise_error DataNotFoundError
     end
 
     it 'should raise a contract output error if nil is returned' do
       tc = TestContract.new
-      tc.should_receive(:test_alias).and_return(nil) 
+      allow(tc).to receive(:test_alias).and_return(nil) 
       expect { tc.test id: 1 }.to raise_error ContractOutputError
     end
 

data/spec/entity_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../lib/obvious/entity'
 
 class Thing < Obvious::Entity
-  value :id, Fixnum 
+  value :id, Integer 
   value :name, String 
 end
 
@@ -36,8 +36,8 @@ describe Thing do
   it 'should create a valid object with valid input' do
     input = { name: 'Thing', id: 1 }
     t = Thing.new input
-    t.name.should eq 'Thing'
-    t.id.should eq 1
+    expect(t.name).to eq 'Thing'
+    expect(t.id).to eq 1
   end
 
   it 'should raise an error with invalid input types' do
@@ -59,7 +59,7 @@ describe Thing do
     it 'should return a hash representation of the object' do
       input = { name: 'Thing', id: 1 }
       t = Thing.new input
-      t.to_hash.should eq input
+      expect(t.to_hash).to eq input
     end
   end
 

data/spec/obj_spec.rb

@@ -7,7 +7,7 @@ class TestObj
     @local = 'set!'
   end
 
-  define :defined_method, with_foo: [:foo, String], also_bar: [:bar, Fixnum] do |input|
+  define :defined_method, with_foo: [:foo, String], also_bar: [:bar, Integer] do |input|
     input
   end
 
@@ -26,37 +26,37 @@ describe Obvious::Obj do
   describe 'self.define' do
     it 'should do the right thing with correct input' do
       result = @test.defined_method with_foo: 'hello', also_bar: 12
-      result.should eq foo: 'hello', bar: 12
+      expect(result).to eq foo: 'hello', bar: 12
     end
 
     it 'should have access to instance variables' do
       result = @test.defined_local
-      result.should eq 'set!' 
+      expect(result).to eq 'set!' 
     end
 
     it 'should raise an error for missing parameters' do
       expect { @test.defined_method with_foo: 'hello' }.to raise_error { |error| 
-        error.should be_a ArgumentError
-        error.message.should eq 'missing input field also_bar'
+        expect(error).to be_a ArgumentError
+        expect(error.message).to eq 'missing input field also_bar'
       }
     end
 
     it 'should raise an error for extra parameters' do
       expect { @test.defined_method with_foo: 'hello', also_bar: 12, and_extra: 'this is extra!' }.to raise_error { |error|
-        error.should be_a ArgumentError
-        error.message.should eq 'invalid input field and_extra'
+        expect(error).to be_a ArgumentError
+        expect(error.message).to eq 'invalid input field and_extra'
       }
     end
 
     it 'should raise an error for invalid types' do
       expect { @test.defined_method with_foo: 1, also_bar: 12 }.to raise_error { |error|
-        error.should be_a ArgumentError 
-        error.message.should eq 'invalid type for with_foo expected String'
+        expect(error).to be_a ArgumentError 
+        expect(error.message).to eq 'invalid type for with_foo expected String'
       }
 
       expect {@test.defined_method with_foo: 'hello', also_bar: nil }.to raise_error { |error|
-        error.should be_a ArgumentError
-        error.message.should eq 'invalid type for also_bar expected Fixnum'
+        expect(error).to be_a ArgumentError
+        expect(error.message).to eq 'invalid type for also_bar expected Integer'
       } 
     end
   end

metadata

@@ -1,27 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: obvious
 version: !ruby/object:Gem::Version
-  version: 0.0.10
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Brian Knapp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-29 00:00:00.000000000 Z
+date: 2022-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70261718685980 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70261718685980
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A set of tools to build apps using the Obvious Architecture
 email:
 - brianknapp@gmail.com
@@ -30,8 +32,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".github/workflows/obvious.yml"
+- ".gitignore"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -58,28 +62,26 @@ files:
 - spec/spec_helper.rb
 homepage: http://obvious.retromocha.com/
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
-summary: Isn't it Obvious?
+specification_version: 4
+summary: Clean Architecture framework
 test_files:
 - spec/.spec_helper.rb.swp
 - spec/contract_spec.rb
@@ -87,4 +89,3 @@ test_files:
 - spec/generators/descriptor_spec.rb
 - spec/obj_spec.rb
 - spec/spec_helper.rb
-has_rdoc: