obvious 0.0.7 → 0.0.8

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+*.swp
 .bundle
 .config
 .yardoc

data/lib/generators/application_generator.rb

@@ -30,7 +30,8 @@ module Obvious
 
           puts 'Creating actions from descriptors... ' unless descriptors.length.zero?
           descriptors.each do |file|
-            descriptor = Obvious::Generators::Descriptor.new file
+            yaml = YAML.load_file(file)
+            descriptor = Obvious::Generators::Descriptor.new yaml
             descriptor.to_file
           end
 
@@ -150,22 +151,22 @@ class #{k}Contract < Contract
 end
 }
 
-            snake_name = name.gsub(/(.)([A-Z])/,'\1_\2').downcase
+            snake_name = k.gsub(/(.)([A-Z])/,'\1_\2').downcase
 
-            filename = "#{@app.dir}/contracts/#{snake_name}_jack_contract.rb"
+            filename = "#{@app.dir}/contracts/#{snake_name}_contract.rb"
             File.open(filename, 'w') {|f| f.write(output) }
 
-            output = %Q{require_relative '../../contracts/#{snake_name}_jack_contract'
+            output = %Q{require_relative '../../contracts/#{snake_name}_contract'
 
 describe #{k}Contract do
   #{method_specs}
 end
 }
 
-            filename = "#{@app.dir}/spec/contracts/#{snake_name}_jack_spec.rb"
+            filename = "#{@app.dir}/spec/contracts/#{snake_name}_spec.rb"
             File.open(filename, 'w') {|f| f.write(output) }
 
-            output = %Q{require_relative '../../contracts/#{snake_name}_jack_contract'
+            output = %Q{require_relative '../../contracts/#{snake_name}_contract'
 
 class #{k}Double
   def self.create behavior
@@ -187,7 +188,7 @@ class #{k}_BadOutput < #{k}Contract
 end
 }
 
-            filename = "#{@app.dir}/spec/doubles/#{snake_name}_jack_double.rb"
+            filename = "#{@app.dir}/spec/doubles/#{snake_name}_double.rb"
             File.open(filename, 'w') {|f| f.write(output) }
 
           end

data/lib/generators/descriptor.rb

@@ -4,22 +4,25 @@ require_relative 'helpers/application'
 
 module Obvious
   module Generators
+    class InvalidDescriptorError < StandardError; end
+
     class Descriptor
       def initialize descriptor
         @descriptor = descriptor
       end
 
       def to_file
-        action = YAML.load_file @descriptor
+        validate_descriptor
+        
         @jacks, @entities = {}, {}
         @code = ''
 
-        action['Code'].each do |entry|
+        @descriptor['Code'].each do |entry|
           write_comments_for entry
           process_requirements_for entry if entry['requires']
         end
 
-        write_action action
+        write_action
       end
 
       private
@@ -53,12 +56,12 @@ module Obvious
         end
       end # #process_requirements_for
 
-      def write_action action
+      def write_action
         jacks_data   = process_jacks
         requirements = require_entities
 
         output = %Q{#{requirements}
-class #{action['Action']}
+class #{@descriptor['Action']}
 
   def initialize #{jacks_data[:inputs]}
 #{jacks_data[:assignments]}  end
@@ -68,24 +71,24 @@ class #{action['Action']}
 end
 }
 
-        snake_name = action['Action'].gsub(/(.)([A-Z])/,'\1_\2').downcase
+        snake_name = @descriptor['Action'].gsub(/(.)([A-Z])/,'\1_\2').downcase
 
         filename = "#{Obvious::Generators::Application.instance.dir}/actions/#{snake_name}.rb"
         File.open(filename, 'w') {|f| f.write(output) }
 
-  output = %Q{require_relative '../../actions/#{snake_name}'
+        output = %Q{require_relative '../../actions/#{snake_name}'
 
-describe #{action['Action']} do
+describe #{@descriptor['Action']} do
 
-  it '#{action['Description']}'
+  it '#{@descriptor['Description']}'
 
   it 'should raise an error with invalid input'
 
 end
-}
+        }
 
-  filename = "#{Obvious::Generators::Application.instance.dir}/spec/actions/#{snake_name}_spec.rb"
-  File.open(filename, 'w') {|f| f.write(output) }
+        filename = "#{Obvious::Generators::Application.instance.dir}/spec/actions/#{snake_name}_spec.rb"
+        File.open(filename, 'w') {|f| f.write(output) }
       end
 
       def process_jacks
@@ -116,6 +119,13 @@ end
 
         entity_requires
       end
+
+      def validate_descriptor
+        raise InvalidDescriptorError unless @descriptor
+        raise InvalidDescriptorError if @descriptor['Code'].nil?
+        raise InvalidDescriptorError if @descriptor['Action'].nil?
+        raise InvalidDescriptorError if @descriptor['Description'].nil?
+      end
     end # ::Descriptor
   end
 end

data/lib/obvious/contract.rb

@@ -91,8 +91,9 @@ class Contract
   # of the output_shape.
   def call_method method, input, input_shape, output_shape
     if input != nil && input_shape != nil
-      unless input.has_shape? input_shape
-        raise ContractInputError, 'incorrect input data format'
+      has_shape, error_field = input.has_shape? input_shape, true
+      unless has_shape 
+        raise ContractInputError, "incorrect input data format field #{error_field}"
       end
 
       result = self.send method, input
@@ -106,6 +107,10 @@ class Contract
       raise ContractOutputError, 'incorrect output data format'
     end
 
+    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
@@ -120,8 +125,9 @@ class Contract
       if result.class == Array
         inner_shape = output_shape[0]
         result.each do |item|
-          unless item.has_shape? inner_shape
-            raise ContractOutputError, 'incorrect output data format'
+          has_shape, error_field = item.has_shape? inner_shape, true
+          unless has_shape 
+            raise ContractOutputError, "incorrect output data format field #{error_field}"
           end
         end
 
@@ -140,8 +146,9 @@ class Contract
     end
 
     # we want result to be output_shape's shape
-    unless result.has_shape? output_shape
-      raise ContractOutputError, 'incorrect output data format'
+    has_shape, error_field = result.has_shape? output_shape, true
+    unless has_shape 
+      raise ContractOutputError, "incorrect output data format field #{error_field}"
     end
 
     result
@@ -162,18 +169,41 @@ class Hash
   #     shape = { k1: Array, k2: { k3: Module } }
   #     h.has_shape?(shape)
   #     #=> true
-  def has_shape?(shape)
+  def has_shape?(shape, return_field = false)
+    return_value = lambda { |r, f|
+      if return_field
+        return r, f
+      else
+        return r 
+      end
+    }
+ 
     # I added an empty check
     if self.empty?
-      return shape.empty?
-    end
-
-    shape.all? do |k, v|
+      return return_value.call shape.empty?, nil
+    end  
+ 
+    self.each do |k, v|
+      return return_value.call false, k if shape[k] == nil
+    end 
+
+    shape.each do |k, v|
       # hash_value
       hv = self[k]
-      Hash === hv ? hv.has_shape?(v) : v === hv
+      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) 
+      else
+        return return_value.call false, k unless v === hv
+      end
     end
+
+    return_value.call true, nil
   end
+
 end
 
 class ContractInputError < StandardError
@@ -181,3 +211,7 @@ end
 
 class ContractOutputError < StandardError
 end
+
+class DataNotFoundError < StandardError
+end
+

data/lib/obvious/entity.rb

@@ -0,0 +1,74 @@
+
+module Obvious
+
+  module EntityMixin 
+    class << self
+      def included(base)
+        base.extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      attr_reader :shape
+      attr_reader :validations
+
+      def value name, type 
+        name = name.to_sym
+        @shape ||= {}
+        @shape[name] = type   
+        define_method(name) { @values[name] }
+      end
+
+      def validation name, method
+        name = "#{name}_validation".to_sym
+        @validations ||= [] 
+        @validations << name 
+        define_method(name) { instance_exec &method }
+      end
+    end
+  end
+
+  class ShapeError < StandardError; end
+  class TypeError < StandardError; end
+  class ValidationError < StandardError; end
+
+  class Entity
+    include EntityMixin
+
+    def initialize input
+      shape = self.class.shape
+      validations = self.class.validations || []
+      
+      self.class.shape.freeze
+      self.class.validations.freeze
+
+      @values = {}
+      input.each do |k, v|
+        unless shape[k]
+          raise Obvious::ShapeError.new "Invalid input field: #{k}" 
+        else
+          @values[k] = v
+        end
+      end 
+      
+      @values.freeze # this might need to be recursive?
+
+      shape.each do |k, v|
+        unless @values[k].class == v
+          msg = "Validation Error: Invalid value for #{k}, should be a #{v}"
+          raise Obvious::TypeError.new msg 
+        end
+      end
+
+      validations.each { |method| send method } 
+
+      freeze
+    end 
+
+    def to_hash
+      {}.tap {|h| @values.each { |k, v| h[k] = v } }
+    end
+
+  end
+end
+

data/lib/obvious/files/external/fs_plug.rb

@@ -6,13 +6,19 @@ class FsPlug
     @filename = filename
   end
 
-  def save input
-    # open the file
+  def load_data
     contents = File.read @filename
+    JSON.parse contents, :symbolize_names => true
+  end
 
+  def save_data input
+    json_data = JSON.pretty_generate input 
+    File.open(@filename, 'w') {|f| f.write(json_data) }
+  end
+
+  def save input
     data = []
-    # parse the json list
-    query = JSON.parse contents, :symbolize_names => true
+    query = load_data 
 
     new_element = true if input[:id] == -1 # by convention set new element flag if id == -1
 
@@ -27,51 +33,37 @@ class FsPlug
     end
 
     # add data to the list if it's a new element 
-    input[:id] = max_id + 1
-    data << input if new_element
+    if new_element 
+      input[:id] = max_id + 1
+      data << input 
+    end
 
-    # save the data back to FS
-    json_data = JSON.pretty_generate data 
-    File.open(@filename, 'w') {|f| f.write(json_data) }
+    save_data data
 
     # return the transformed data
     input
   end
 
   def list
-    # open the file
-    contents = File.read @filename
-
-    # parse the json list
-    data = JSON.parse contents, :symbolize_names => true
-    
-    # return the transformed data
-    data 
+    load_data
   end
   
   def get input
-    # open the file
-    contents = File.read @filename
-
     data = []
-    # parse the json list
-    query = JSON.parse contents, :symbolize_names => true
+    query = load_data 
 
     # transform the data if needed
     query.each do |h|
       return h if h[:id] == input[:id]
     end 
 
-    {} 
+    raise Exception.new 'no object found'
   end
 
   def remove input
-    # open the file
-    contents = File.read @filename
-
     data = []
     # parse the json list
-    query = JSON.parse contents, :symbolize_names => true
+    query = load_data 
 
     # transform the data if needed
     query.each do |h|
@@ -80,15 +72,28 @@ class FsPlug
       end
     end
 
-    # save the data back to FS
-    json_data = JSON.pretty_generate data 
-    File.open(@filename, 'w') {|f| f.write(json_data) }
+    save_data data
 
     # return true on success
     true 
   end
 
+  def find input
+    data = []
+    query = load_data 
+ 
+    key = input.keys[0] 
+ 
+    query.each do |h|
+      if input[key] == h[key]
+        return h
+      end
+    end 
+
+    raise Exception.new 'no object found'
+  end
 end
 
 
 
+

data/lib/obvious/files/external/mongo_plug.rb

@@ -1,5 +1,10 @@
 require 'moped'
 
+# To get the mongo system to work you need to have a counters collection. The
+# code here will increment the seq field which we use to set the id. If you are
+# having problems, you probably need to create the collection and add entries
+# for each other collection you want to have an id sequence.
+
 class MongoPlug
   def initialize collection
     @collection = collection

data/lib/obvious/files/external/s3_plug.rb

@@ -0,0 +1,94 @@
+require 'json'
+require 'aws/s3'
+
+class S3Plug
+  include AWS::S3
+
+  def initialize input 
+    @filename = input[:filename]
+    @bucket = input[:bucket]
+
+    # you can test locally with the fake-s3 gem: https://github.com/jubos/fake-s3
+    # or just swap out for the filesystem plug locally
+    s3_key = ENV['S3_KEY'] || '123'
+    s3_secret = ENV['S3_SECRET'] || 'abc'
+    s3_server = ENV['S3_SERVER'] || '0.0.0.0'
+    s3_port = ENV['S3_PORT'] || '10001'
+
+    AWS::S3::Base.establish_connection!(:access_key_id => s3_key,
+                                        :secret_access_key => s3_secret,
+                                        :server => s3_server,
+                                        :port => s3_port)
+  end
+
+  def load_data
+    contents = S3Object.value @filename, @bucket
+    JSON.parse contents, :symbolize_names => true
+  end
+
+  def save_data data
+    json_data = JSON.pretty_generate data 
+    S3Object.store @filename, json_data, @bucket
+  end
+
+  def save input
+    data = []
+    result = load_data
+    new_element = true if input[:id] == -1 # by convention set new element flag if id == -1
+
+    max_id = -1
+    # transform the data if needed
+    result.each do |h|
+      if input[:id] == h[:id]
+        h = input
+      end
+      max_id = h[:id] if h[:id] > max_id
+      data << h
+    end
+
+    # add data to the list if it's a new element 
+    if new_element
+      input[:id] = max_id + 1
+      data << input
+    end
+   
+    save_data data 
+
+    # return the transformed data
+    input
+  end
+
+  def list
+    load_data 
+  end
+  
+  def get input
+    data = []
+    result = load_data
+
+    # transform the data if needed
+    result.each do |h|
+      return h if h[:id] == input[:id]
+    end 
+
+    {} 
+  end
+
+  def remove input
+    data = []
+    result = load_data
+
+    # transform the data if needed
+    result.each do |h|
+      unless h[:id] == input[:id]
+        data << h 
+      end
+    end
+
+    save_data data
+
+    # return true on success
+    true 
+  end
+end
+

data/lib/obvious/version.rb

@@ -1,3 +1,3 @@
 module Obvious
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/obvious.rb

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

data/obvious.gemspec

@@ -16,4 +16,6 @@ Gem::Specification.new do |gem|
   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/spec/contract_spec.rb

@@ -0,0 +1,63 @@
+require_relative 'spec_helper'
+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
+    end
+    
+    it 'should return false for an invalid shape' do
+      { id: 1 }.has_shape?(id: String).should 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]
+    end
+
+    it 'should allow for nil values to be returned' do
+      { id: nil }.has_shape?({id: String}).should be true
+    end 
+  end
+end
+
+class TestContract < Contract
+  contract_for :test, {
+    input: { id: Fixnum },
+    output: { id: Fixnum, value: String }
+  }
+
+  def test input
+    { id: 1, value: 'this is a test' } 
+  end
+end
+
+describe 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'
+    end
+  
+    it 'should raise a contract input error with bad input' do
+      tc = TestContract.new
+      expect { tc.test Hash.new }.to raise_error ContractInputError
+    end
+
+    it 'should raise a DataNotFound error if {} is returned' do
+      tc = TestContract.new
+      tc.should_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) 
+      expect { tc.test id: 1 }.to raise_error ContractOutputError
+    end
+
+  end
+end

data/spec/entity_spec.rb

@@ -0,0 +1,75 @@
+require_relative '../lib/obvious/entity'
+
+class Thing < Obvious::Entity
+  value :id, Fixnum 
+  value :name, String 
+end
+
+class Thing2 < Obvious::Entity
+  value :foo , String
+
+  validation :something, Proc.new {
+    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, Proc.new {
+    @values[:foo] = 12
+  }
+
+end
+
+# To test the entity, we are going to use classes that inherit from it instead
+# of poking at it directly. In this case, I think that makes the most sense.
+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
+  end
+
+  it 'should raise an error with invalid input types' do
+    input = { name: nil, id: nil }
+    expect { Thing.new input }.to raise_error Obvious::TypeError
+  end
+
+  it 'should raise an error with extra fields in input' do
+    input = { name: 'Thing', id: 1, extra: 'should explode' }
+    expect { Thing.new input }.to raise_error Obvious::ShapeError
+  end
+
+  it 'should raise an error when a method tries to modify a value' do
+    t = Thing2.new foo: 'hello world'
+    expect { t.modify_foo }.to raise_error RuntimeError
+  end
+
+  describe '#to_hash' 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
+    end
+  end
+
+  describe 'validation' do
+    it 'should raise a validation error on a failed validation' do
+      expect { Thing2.new foo: 'not valid I promise!' }.to raise_error Obvious::ValidationError
+    end
+    
+    it 'should raise an error when trying to modify an object in a validation' do
+      expect { Thing3.new foo: 'hello world' }.to raise_error RuntimeError
+    end
+  end
+end

data/spec/generators/descriptor_spec.rb

@@ -0,0 +1,34 @@
+require_relative '../../lib/generators/descriptor'
+
+require File.expand_path('spec/spec_helper')
+
+module Obvious
+  module Generators
+    describe Descriptor do
+      subject {Descriptor.new(yaml_file)}
+
+      describe "#to_file" do
+       
+        context "when the descriptor is empty" do
+          let( :yaml_file ) { {} }
+
+          it "should raise a meaningful error" do
+           expect {subject.to_file}.to raise_error(InvalidDescriptorError)
+          end
+        end
+
+        ["Action", "Code", "Description"].each do |section|
+          context "when the '#{section}' section is omitted" do
+            let( :yaml_file ) {
+              {"Action" => "Jackson", "Description" => "This is something"}.delete(section)
+            }
+
+            it "should raise a meaningful error" do
+              expect {subject.to_file}.to raise_error(InvalidDescriptorError)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |c|
+  c.mock_with :rspec 
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: obvious
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,19 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-19 00:00:00.000000000 Z
-dependencies: []
+date: 2013-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70341046505020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70341046505020
 description: A set of tools to build apps using the Obvious Architecture
 email:
 - brianknapp@gmail.com
@@ -30,12 +41,19 @@ files:
 - 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/version.rb
 - obvious.gemspec
+- spec/.spec_helper.rb.swp
+- spec/contract_spec.rb
+- spec/entity_spec.rb
+- spec/generators/descriptor_spec.rb
+- spec/spec_helper.rb
 homepage: http://obvious.retromocha.com/
 licenses: []
 post_install_message: 
@@ -60,5 +78,10 @@ rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Isn't it Obvious?
-test_files: []
+test_files:
+- spec/.spec_helper.rb.swp
+- spec/contract_spec.rb
+- spec/entity_spec.rb
+- spec/generators/descriptor_spec.rb
+- spec/spec_helper.rb
 has_rdoc: