obvious 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bf4de686eee48c524a3037620e21a154db8c75fce3ff8db780afc25dc376202
-  data.tar.gz: c4930e55f1420a9b40996fc042052f267548b3f6017055ad69355c44bad28f7e
+  metadata.gz: 9a0c1346518213e685185d08916b2c573697ca5d6be5763f8cfe245febeac4f0
+  data.tar.gz: 2125df9f05284d2e34b16edb85ee14f73d1d1f2a296df90c7a2b4e2a795ab81f
 SHA512:
-  metadata.gz: 377a83eba55eeadeb63bdadd1a12f72a81507b5d029486add3ffba65fd81c4de929936e435bc73ac0816185bab6dff2a0aa1b4ecfcf527fa36d4dbdc13abaf81
-  data.tar.gz: 6f7a51c4037baa95be253c62a801f1c8204e662b089bc45bd7f6db1df94f6c39d1130625fb745a7c558111662c5baeaf59372817a077f17d14faf7af2ce0b394
+  metadata.gz: 1f8684fe2bc370eb3d2cec4933e3281a00b0633a5829cdee580b36632d330e6b71ba605612bd1ef5f5cfa6884ed66369a50117f68d3b1a9a9ec73a0c3e5bdfda
+  data.tar.gz: f393f71805593ff5b748477ebe9486148c356fdb73b1fb09f108453611ceabf4cce982768914c10de719012b0782659bf57ab4e91357871173551d60fb4503ff

data/.github/workflows/obvious.yml

@@ -16,4 +16,4 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
       - run: |
-          bundle exec rspec
+          ruby -Ilib:test test/*_test.rb

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.2.0]
+
+### Added
+
+### Changed
+
+- Updated README to be current
+- Removed generators from Obvious
+- Refactored Obvious::Obj#define to be simpler
+- Replaced RSPec with Minitest for testing
+
+### Fixed
+
+- Fixed namespace issues with Contract errors
+- Updated project URL on Rubygems listing

data/Gemfile.lock

@@ -1,25 +1,11 @@
 PATH
   remote: .
   specs:
-    obvious (0.1.0)
+    obvious (0.2.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
@@ -28,7 +14,6 @@ PLATFORMS
 
 DEPENDENCIES
   obvious!
-  rspec
 
 BUNDLED WITH
    2.3.4

data/README.md

@@ -1,20 +1,9 @@
 # Obvious
 
-Obvious is an architecture framework. The goal is to provide architectural structure for a highly testable system that is 
-obvious to understand and where both the front end UI and back end infrastructure are treated as implementation details 
-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).
-
+Obvious is an architecture framework. The goal is to provide architectural
+structure for a highly testable system that is obvious to understand and where
+both the front end UI and back end infrastructure are treated as implementation
+details independent of the app logic itself.
 
 ## Installation
 
@@ -25,23 +14,3 @@ Add this line to your application's Gemfile:
 And then execute:
 
     $ bundle
-
-Or install it yourself as:
-
-    $ gem install obvious
-
-## Usage
-
-Obvious is designed to be used in two ways - as a gem you require in your Obvious projects and also as an Obvious project 
-generation tool. 
-
-The project generation tool is run by executing...
-
-    $ obvious generate 
-
-in a directory containing a decriptors directory. You can read more about descriptors on the Obvious page or see an example
-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.

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+task :default => :test

data/lib/obvious/contract.rb

@@ -94,8 +94,8 @@ module Obvious
     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}"
+        unless has_shape
+          raise Obvious::ContractInputError, "incorrect input data format field #{error_field}"
         end
 
         result = self.send method, input
@@ -106,11 +106,11 @@ module Obvious
       # check output
       # output should never be nil
       if result == nil
-        raise ContractOutputError, 'incorrect output data format'
+        raise Obvious::ContractOutputError, 'incorrect output data format'
       end
 
       if result === {}
-        raise DataNotFoundError, 'data was not found'
+        raise Obvious::DataNotFoundError, 'data was not found'
       end
 
       # we are looking for result to be a True object
@@ -118,7 +118,7 @@ module Obvious
         if output_shape == result
           return result
         else
-          raise ContractOutputError, 'incorrect output data format'
+          raise Obvious::ContractOutputError, 'incorrect output data format'
         end
       end
 
@@ -128,20 +128,20 @@ module Obvious
           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}"
+            unless has_shape
+              raise Obvious::ContractOutputError, "incorrect output data format field #{error_field}"
             end
           end
 
           return result
         end
-        raise ContractOutputError, 'incorrect output data format'
+        raise Obvious::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'
+          raise Obvious::ContractOutputError, 'incorrect output data format'
         end
 
         return result
@@ -149,8 +149,8 @@ module Obvious
 
       # 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}"
+      unless has_shape
+        raise Obvious::ContractOutputError, "incorrect output data format field #{error_field}"
       end
 
       result
@@ -158,6 +158,15 @@ module Obvious
 
   end
 
+
+  class ContractInputError < StandardError
+  end
+
+  class ContractOutputError < StandardError
+  end
+
+  class DataNotFoundError < StandardError
+  end
 end
 
 # via https://github.com/citizen428/shenanigans/blob/master/lib/shenanigans/hash/has_shape_pred.rb
@@ -178,28 +187,28 @@ class Hash
       if return_field
         return r, f
       else
-        return r 
+        return r
       end
     }
- 
+
     # I added an empty check
     if self.empty?
       return return_value.call shape.empty?, nil
-    end  
- 
+    end
+
     self.each do |k, v|
       return return_value.call false, k if shape[k] == nil
-    end 
+    end
 
     shape.each do |k, v|
       # hash_value
       hv = self[k]
-      return return_value.call false, k unless self.has_key? k 
+      return return_value.call false, k unless self.has_key? k
 
       next if hv === nil
 
-      if Hash === hv 
-        return hv.has_shape?(v, return_field) 
+      if Hash === hv
+        return hv.has_shape?(v, return_field)
       else
         return return_value.call false, k unless v === hv
       end
@@ -211,18 +220,8 @@ class Hash
   def nil_fields? list
     list.each do |field|
       return true, field unless self[field]
-    end  
-    
+    end
+
     return false, nil
   end
 end
-
-class ContractInputError < StandardError
-end
-
-class ContractOutputError < StandardError
-end
-
-class DataNotFoundError < StandardError
-end
-

data/lib/obvious/obj.rb

@@ -5,31 +5,29 @@ module Obvious
         base.extend ClassMethods
       end
     end
-   
+
     module ClassMethods
 
-      def define method, input = {}, &block 
-        define_method(method)  do |method_input = {}| 
+      def define method, input = {}, &block
+        define_method(method) do |method_input = {}|
           block_input = {}
-          method_input.each do |k,v| 
-            if input[k].nil? 
+          method_input.each do |k,v|
+            if input[k].nil?
               raise ArgumentError.new "invalid input field #{k}"
-            end 
-
-            unless v.is_a? input[k][1]
-              raise ArgumentError.new "invalid type for #{k} expected #{input[k][1]}"
-            end 
+            end
 
-            block_input[input[k][0]] = v
+            unless v.is_a? input[k]
+              raise ArgumentError.new "invalid type for #{k} expected #{input[k]}"
+            end
           end
-   
+
           input.each do |k,v|
-            if block_input[v[0]].nil?
+            if method_input[k].nil?
               raise ArgumentError.new "missing input field #{k}"
             end
           end
 
-          self.instance_exec block_input, &block 
+          self.instance_exec method_input, &block
         end
       end
 

data/lib/obvious/version.rb

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

data/lib/obvious.rb

@@ -2,4 +2,3 @@ require 'obvious/version'
 require 'obvious/contract'
 require 'obvious/entity'
 require 'obvious/obj'
-require_relative 'generators/application_generator'

data/obvious.gemspec

@@ -6,16 +6,14 @@ require 'obvious/version'
 Gem::Specification.new do |gem|
   gem.name          = "obvious"
   gem.version       = Obvious::VERSION
-  gem.authors       = ["Brian Knapp"]
-  gem.email         = ["brianknapp@gmail.com"]
+  gem.authors       = ["Brian Knapp", "Shawn Baden"]
+  gem.email         = ["brianknapp@gmail.com", "shawnbaden@hotmail.com"]
   gem.description   = "A set of tools to build apps using the Obvious Architecture"
   gem.summary       = "Clean Architecture framework"
-  gem.homepage      = "http://obvious.retromocha.com/"
-
+  gem.homepage      = "https://github.com/RetroMocha/obvious"
+  gem.license       = "MIT"
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-
-  gem.add_development_dependency "rspec"
 end

data/test/contract_test.rb

@@ -0,0 +1,62 @@
+require 'minitest/autorun'
+require_relative '../lib/obvious/contract'
+
+class TestContract < Obvious::Contract
+  contract_for :test, {
+    input: { id: Integer },
+    output: { id: Integer, value: String }
+  }
+
+  def test input
+    { id: 1, value: 'this is a test' }
+  end
+end
+
+class ContractTest < Minitest::Test
+  def test_valid_input
+    result = TestContract.new.test(id: 1)
+    assert_equal({id: 1, value: 'this is a test'}, result)
+  end
+
+  def test_invalid_input
+    assert_raises Obvious::ContractInputError do
+      TestContract.new.test(Hash.new)
+    end
+  end
+
+  def test_empty_hash_return
+    assert_raises Obvious::DataNotFoundError do
+      tc = TestContract.new
+      tc.stub :test_alias, {} do
+        tc.test(id: 1)
+      end
+    end
+  end
+
+  def test_nil_return
+    assert_raises Obvious::ContractOutputError do
+      tc = TestContract.new
+      tc.stub :test_alias, nil do
+        tc.test(id: 1)
+      end
+    end
+  end
+end
+
+class HashTest < Minitest::Test
+  def test_valid_has_shape
+    assert({id: 1}.has_shape?(id: Integer))
+  end
+
+  def test_invalid_has_shape
+    refute({id: 1}.has_shape?(id: String))
+  end
+
+  def test_has_shape_allow_nil_values
+    assert({id: nil}.has_shape?({id: String}))
+  end
+
+  def test_has_shape_return_invalid_field
+    assert_equal([false, :id], { id: 1 }.has_shape?({id: String}, true))
+  end
+end

data/test/entity_test.rb

@@ -0,0 +1,76 @@
+require 'minitest/autorun'
+require_relative '../lib/obvious/entity'
+
+class Thing < Obvious::Entity
+  value :id, Integer
+  value :name, String
+end
+
+class Thing2 < Obvious::Entity
+  value :foo , String
+
+  validation :something, -> {
+    if foo != "hello world"
+      msg = "Validation Error: Invalid value for foo, should be 'hello world'"
+      raise Obvious::ValidationError.new msg
+    end
+  }
+
+  def modify_foo
+    @values[:foo] = 100
+  end
+end
+
+class Thing3 < Obvious::Entity
+  value :foo , String
+
+  validation :something, -> {
+    @values[:foo] = 12
+  }
+end
+
+
+# Test code begins here
+
+class EntityTest < Minitest::Test
+  def test_valid_input
+    t = Thing.new(name: 'Thing', id: 1)
+    assert_equal('Thing', t.name)
+    assert_equal(1, t.id)
+  end
+
+  def test_invalid_input_types
+    assert_raises Obvious::TypeError do
+      Thing.new(name: nil, id: nil)
+    end
+  end
+
+  def test_invalid_extra_field
+    assert_raises Obvious::ShapeError do
+      Thing.new(name: 'Thing', id: 1, extra: 'should explode')
+    end
+  end
+
+  def test_method_modify_value
+    assert_raises RuntimeError do
+      Thing2.new(foo: 'hello world').modify_foo
+    end
+  end
+
+  def test_to_hash
+    t = Thing.new(name: 'Thing', id: 1)
+    assert_equal({name: 'Thing', id: 1}, t.to_hash)
+  end
+
+  def test_failed_validation
+    assert_raises Obvious::ValidationError do
+      Thing2.new(foo: 'not valid I promise!')
+    end
+  end
+
+  def test_modify_value_inside_validation
+    assert_raises RuntimeError do
+      Thing3.new(foo: 'hello world')
+    end
+  end
+end

data/test/obj_test.rb

@@ -0,0 +1,65 @@
+require 'minitest/autorun'
+require_relative '../lib/obvious/obj'
+
+class TestObj
+  include Obvious::Obj
+
+  def initialize
+    @local = 'set!'
+  end
+
+  define :defined_method, foo: String, bar: Integer do |input|
+    input
+  end
+
+  define :defined_local do |input|
+    @local
+  end
+
+  define :early_return_example do |input|
+    next true
+    false
+  end
+end
+
+class ObjTest < Minitest::Test
+  def test_valid_input
+    result = TestObj.new.defined_method foo: 'hello', bar: 12
+    assert_equal({foo: 'hello', bar: 12}, result)
+  end
+
+  def test_access_instance_variables
+    result = TestObj.new.defined_local
+    assert_equal('set!', result)
+  end
+
+  def test_missing_parameters
+    error = assert_raises ArgumentError do
+      TestObj.new.defined_method foo: 'hello'
+    end
+    assert_equal('missing input field bar', error.message)
+  end
+
+  def test_extra_parameters
+    error = assert_raises ArgumentError do
+      TestObj.new.defined_method foo: 'hello', bar: 12, extra: 'fail'
+    end
+    assert_equal('invalid input field extra', error.message)
+  end
+
+  def test_invalid_types
+    error = assert_raises ArgumentError do
+      TestObj.new.defined_method foo: 1, bar: 12
+    end
+    assert_equal('invalid type for foo expected String', error.message)
+
+    error = assert_raises ArgumentError do
+      TestObj.new.defined_method foo: 'hello', bar: nil
+    end
+    assert_equal('invalid type for bar expected Integer', error.message)
+  end
+
+  def test_early_return
+    assert(TestObj.new.early_return_example)
+  end
+end

metadata

@@ -1,67 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: obvious
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Brian Knapp
+- Shawn Baden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2022-02-02 00:00:00.000000000 Z
+dependencies: []
 description: A set of tools to build apps using the Obvious Architecture
 email:
 - brianknapp@gmail.com
-executables:
-- obvious
+- shawnbaden@hotmail.com
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/obvious.yml"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/obvious
-- lib/generators/application_generator.rb
-- lib/generators/descriptor.rb
-- lib/generators/helpers/application.rb
 - lib/obvious.rb
 - lib/obvious/contract.rb
 - lib/obvious/entity.rb
-- lib/obvious/files/Rakefile
-- lib/obvious/files/external/fs_plug.rb
-- lib/obvious/files/external/mongo_plug.rb
-- lib/obvious/files/external/mysql_plug.rb
-- lib/obvious/files/external/s3_plug.rb
 - lib/obvious/obj.rb
 - lib/obvious/version.rb
 - obvious.gemspec
-- spec/.spec_helper.rb.swp
-- spec/contract_spec.rb
-- spec/entity_spec.rb
-- spec/generators/descriptor_spec.rb
-- spec/obj_spec.rb
-- spec/spec_helper.rb
-homepage: http://obvious.retromocha.com/
-licenses: []
+- test/contract_test.rb
+- test/entity_test.rb
+- test/obj_test.rb
+homepage: https://github.com/RetroMocha/obvious
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -83,9 +60,6 @@ signing_key:
 specification_version: 4
 summary: Clean Architecture framework
 test_files:
-- spec/.spec_helper.rb.swp
-- spec/contract_spec.rb
-- spec/entity_spec.rb
-- spec/generators/descriptor_spec.rb
-- spec/obj_spec.rb
-- spec/spec_helper.rb
+- test/contract_test.rb
+- test/entity_test.rb
+- test/obj_test.rb

data/bin/obvious

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'obvious'
-
-if ARGV[0] == 'generate'
-  Obvious::Generators::ApplicationGenerator.generate
-end