obvious 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,10 @@
 # Obvious
 
-TODO: Write a gem description
+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
 
 ## Installation
 
@@ -18,7 +22,19 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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.
 
 ## Contributing
 

data/bin/obvious

@@ -2,6 +2,293 @@
 
 require 'obvious'
 
+require 'yaml'
+
+module Obvious
+  # Your code goes here...
+  def self.generate
+    puts 'generate the codes!a'
+
+
+
+#`rm -rf app`
+
+app_dir = 'app'
+
+counter = 1
+while File.directory? app_dir
+  app_dir = "app_#{counter}"
+  counter += 1
+end
+
+puts "Generating application at: #{app_dir}"
+
+dirs = ['/', '/actions', '/contracts', '/entities',
+        '/spec', '/spec/actions', '/spec/contracts', '/spec/entities',
+        '/spec/doubles']
+
+dirs.each do |dir|
+  Dir.mkdir app_dir + dir
+end
+
+
+target_path = File.realpath Dir.pwd
+spec = Gem::Specification.find_by_name("obvious")
+gem_root = spec.gem_dir
+gem_lib = gem_root + "/lib"
+
+#`cp #{gem_lib}/obvious/files/contract.rb #{target_path}/app/contracts/contract.rb`
+`cp #{gem_lib}/obvious/files/Rakefile #{target_path}/Rakefile`
+entities = Hash.new
+jacks = Hash.new
+
+files = Dir['descriptors/*.yml']
+
+files.each do |file|
+  action = YAML.load_file file
+  code = ''
+  #puts action.inspect
+
+  local_jacks = Hash.new
+  local_entities = Hash.new
+
+  action['Code'].each do |entry|
+    code << "    \# #{entry['c']}\n"
+    code << "    \# use: #{entry['requires']}\n" if entry['requires']
+    code << "    \n"
+
+    if entry['requires']
+      requires = entry['requires'].split(',')
+      requires.each do |req|
+        req.strip!
+        info = req.split '.'
+
+        if info[0].index 'Jack'
+          unless jacks[info[0]]
+            jacks[info[0]] = []
+          end
+
+          unless local_jacks[info[0]]
+            local_jacks[info[0]] = []
+          end
+
+          jacks[info[0]] << info[1]
+          local_jacks[info[0]] << info[1]
+        else
+          unless entities[info[0]]
+            entities[info[0]] = []
+          end
+
+          unless local_entities[info[0]]
+            local_entities[info[0]] = []
+          end
+
+          entities[info[0]] << info[1]
+          local_entities[info[0]] << info[1]
+        end
+
+      end
+    end
+
+  end
+
+
+  jack_inputs = ''
+  jack_assignments = ''
+
+  local_jacks.each do |k, v|
+    name = k.chomp('Jack').downcase
+    jack_inputs << "#{name}_jack, "
+    jack_assignments << "    @#{name}_jack = #{name}_jack\n"
+  end
+
+  jack_inputs.chomp! ', '
+
+  entity_requires = ''
+
+  local_entities.each do |k, v|
+    name = k.downcase
+    entity_requires << "require_relative '../entities/#{name}'\n"
+  end
+
+
+  output = <<FIN
+#{entity_requires}
+class #{action['Action']}
+
+  def initialize #{jack_inputs}
+#{jack_assignments}  end
+
+  def do input
+#{code}  end
+
+end
+FIN
+  snake_name = action['Action'].gsub(/(.)([A-Z])/,'\1_\2').downcase
+
+  filename = "#{app_dir}/actions/#{snake_name}.rb"
+  File.open(filename, 'w') {|f| f.write(output) }
+
+#puts output
+
+  output = <<FIN
+require_relative '../../actions/#{snake_name}'
+
+describe #{action['Action']} do
+
+  it '#{action['Description']}'
+
+  it 'should raise an error with invalid input'
+
+end
+
+
+FIN
+
+  filename = "#{app_dir}/spec/actions/#{snake_name}_spec.rb"
+  File.open(filename, 'w') {|f| f.write(output) }
+
+  #puts output
+end
+
+
+#filter out duplicate methods
+
+entities.each do |k, v|
+  v.uniq!
+end
+
+jacks.each do |k,v|
+  v.uniq!
+end
+
+#puts entities.inspect
+#puts jacks.inspect
+
+entities.each do |k, v|
+  name = k
+  method_specs = ''
+  method_definitions = ''
+
+  v.each do |method|
+    method_definitions << "
+  def #{method} input
+    nil
+  end
+    "
+
+    method_specs << "
+  describe '.#{method}' do
+    it 'should #{method} with valid input'
+
+    it 'should raise an error with invalid input'
+
+  end
+    "
+
+  end
+
+  output = <<FIN
+class #{name}
+#{method_definitions}
+end
+FIN
+  snake_name = name.gsub(/(.)([A-Z])/,'\1_\2').downcase
+
+  filename = "#{app_dir}/entities/#{snake_name}.rb"
+  File.open(filename, 'w') {|f| f.write(output) }
+
+  output = <<FIN
+require_relative '../../entities/#{snake_name}'
+
+describe #{name} do
+#{method_specs}
+end
+
+
+FIN
+  filename = "#{app_dir}/spec/entities/#{snake_name}_spec.rb"
+  File.open(filename, 'w') {|f| f.write(output) }
+
+
+  #puts output
+end
+
+
+
+jacks.each do |k, v|
+
+  name = k.chomp('Jack').downcase
+
+  method_specs = ''
+  method_definitions = ''
+
+  v.each do |method|
+
+    method_definitions << "
+  def #{method}_contract input
+    input_shape = {}
+    output_shape = {}
+    call_method :#{method}_alias, input, input_shape, output_shape
+  end
+    "
+
+    method_specs << "
+  describe '.#{method}_contract' do
+    it 'should #{method} data with valid input'
+
+    it 'should raise an error with invalid input'
+
+    it 'should raise an error with invalid output'
+
+  end
+    "
+
+  end
+
+
+  output = <<FIN
+require 'obvious'
+
+class #{k}Contract < Contract
+  contracts :#{v.join(', :')}
+  #{method_definitions}
+end
+FIN
+
+  snake_name = name.gsub(/(.)([A-Z])/,'\1_\2').downcase
+
+  filename = "#{app_dir}/contracts/#{snake_name}_jack_contract.rb"
+  File.open(filename, 'w') {|f| f.write(output) }
+
+  #puts output
+
+  output = <<FIN
+require_relative '../../contracts/#{snake_name}_jack_contract'
+
+describe #{k}Contract do
+#{method_specs}
+end
+
+FIN
+
+  filename = "#{app_dir}/spec/contracts/#{snake_name}_jack_contract_spec.rb"
+  File.open(filename, 'w') {|f| f.write(output) }
+
+  #puts output
+end
+
+
+
+
+  end
+end
+
+
+
 if ARGV[0] == 'generate'
   Obvious::generate
 end
+
+
+

data/lib/obvious/contract.rb

@@ -1,24 +1,42 @@
 class Contract
   @@disable_override = false
 
-  # This method needs to exist because the method_added bit looks for it. 
-  # It intentionally returns an empty array
-  def self.contracts
+  # Provides a default empty array for method_added
+  # Overriden by self.contracts
+  def self.contract_list
     []
   end
 
-  # This method will move methods defined in self.contracts into new methods.
-  # Each entry in self.contracts will cause the method with the same name to
-  # become method_name_alias and for the original method to point to 
+  # 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
+
+  # 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.contracts.each do |method|
+      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 
+          @@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
@@ -26,24 +44,24 @@ class Contract
           @@disable_override = false
         else
           # puts self.inspect
-          #  puts "defining other method #{name}"
+          # puts "defining other method #{name}"
         end
       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 
+  # 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 
+  # 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 
+  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'
@@ -70,23 +88,23 @@ class Contract
     end
 
     # we want to check the shape of each item in the result array
-    if output_shape.class == Array 
+    if output_shape.class == Array
       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'
           end
-        end       
- 
-        return result 
-      end  
+        end
+
+        return result
+      end
       raise ContractOutputError, 'incorrect output data format'
-    end    
+    end
 
-    # we want result to be true or false 
+    # we want result to be true or false
     if output_shape == :true_false
-      unless result == true || result == false 
+      unless result == true || result == false
         raise ContractOutputError, 'incorrect output data format'
       end
 
@@ -122,8 +140,10 @@ class Hash
       return shape.empty?
     end
 
-    all? do |k, v|
-      Hash === v ? v.has_shape?(shape[k]) : shape[k] === v
+    shape.all? do |k, v|
+      # hash_value
+      hv = self[k]
+      Hash === hv ? hv.has_shape?(v) : v === hv
     end
   end
 end

data/lib/obvious/version.rb

@@ -1,3 +1,3 @@
 module Obvious
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/obvious.rb

@@ -1,285 +1,3 @@
 require 'obvious/version'
 require 'obvious/contract'
-require 'yaml'
 
-module Obvious
-  # Your code goes here...
-  def self.generate
-    puts 'generate the codes!a'
-
-
-
-#`rm -rf app`
-
-app_dir = 'app'
-
-counter = 1
-while File.directory? app_dir
-  app_dir = "app_#{counter}" 
-  counter += 1
-end
-
-puts "Generating application at: #{app_dir}"
-
-dirs = ['/', '/actions', '/contracts', '/entities', 
-        '/spec', '/spec/actions', '/spec/contracts', '/spec/entities', 
-        '/spec/doubles']
-
-dirs.each do |dir|
-  Dir.mkdir app_dir + dir
-end
-
-
-target_path = File.realpath Dir.pwd 
-spec = Gem::Specification.find_by_name("obvious")
-gem_root = spec.gem_dir
-gem_lib = gem_root + "/lib"
-
-#`cp #{gem_lib}/obvious/files/contract.rb #{target_path}/app/contracts/contract.rb`
-`cp #{gem_lib}/obvious/files/Rakefile #{target_path}/Rakefile`
-entities = Hash.new 
-jacks = Hash.new 
-
-files = Dir['descriptors/*.yml'] 
-
-files.each do |file|
-  action = YAML.load_file file 
-  code = ''
-  #puts action.inspect
-
-  local_jacks = Hash.new 
-  local_entities = Hash.new
-
-  action['Code'].each do |entry|
-    code << "    \# #{entry['c']}\n"
-    code << "    \# use: #{entry['requires']}\n" if entry['requires']
-    code << "    \n"
-
-    if entry['requires']
-      requires = entry['requires'].split(',')
-      requires.each do |req|
-        req.strip!
-        info = req.split '.'
-
-        if info[0].index 'Jack'
-          unless jacks[info[0]]
-            jacks[info[0]] = [] 
-          end
-         
-          unless local_jacks[info[0]]
-            local_jacks[info[0]] = [] 
-          end
- 
-          jacks[info[0]] << info[1]        
-          local_jacks[info[0]] << info[1]        
-        else
-          unless entities[info[0]]
-            entities[info[0]] = [] 
-          end    
-
-          unless local_entities[info[0]]
-            local_entities[info[0]] = [] 
-          end    
-      
-          entities[info[0]] << info[1]
-          local_entities[info[0]] << info[1]
-        end
-
-      end
-    end
-
-  end
-
- 
-  jack_inputs = ''
-  jack_assignments = ''
-
-  local_jacks.each do |k, v|
-    name = k.chomp('Jack').downcase
-    jack_inputs << "#{name}_jack, "
-    jack_assignments << "    @#{name}_jack = #{name}_jack\n"
-  end
-
-  jack_inputs.chomp! ', '
-
-  entity_requires = ''
-
-  local_entities.each do |k, v|
-    name = k.downcase
-    entity_requires << "require_relative '../entities/#{name}'\n"
-  end
-
-
-  output = <<FIN
-#{entity_requires}
-class #{action['Action']}
-
-  def initialize #{jack_inputs}
-#{jack_assignments}  end
-
-  def do input
-#{code}  end
-
-end
-FIN
-  snake_name = action['Action'].gsub(/(.)([A-Z])/,'\1_\2').downcase
-  
-  filename = "#{app_dir}/actions/#{snake_name}.rb"
-  File.open(filename, 'w') {|f| f.write(output) }
-
-#puts output
-
-  output = <<FIN
-require_relative '../../actions/#{snake_name}'
-
-describe #{action['Action']} do
-
-  it '#{action['Description']}'
-
-  it 'should raise an error with invalid input'
-
-end
-
-
-FIN
-
-  filename = "#{app_dir}/spec/actions/#{snake_name}_spec.rb"
-  File.open(filename, 'w') {|f| f.write(output) }
-
-  #puts output
-end
-
-
-#filter out duplicate methods
-
-entities.each do |k, v|
-  v.uniq!
-end
-
-jacks.each do |k,v|
-  v.uniq!
-end
-
-#puts entities.inspect
-#puts jacks.inspect
-
-entities.each do |k, v|
-  name = k
-  method_specs = ''
-  method_definitions = ''
-
-  v.each do |method|
-    method_definitions << "
-  def #{method} input
-    nil
-  end
-    " 
-
-    method_specs << "
-  describe '.#{method}' do
-    it 'should #{method} with valid input'
-
-    it 'should raise an error with invalid input'
-
-  end
-    "
-
-  end
-  
-  output = <<FIN
-class #{name}
-#{method_definitions}
-end
-FIN
-  snake_name = name.gsub(/(.)([A-Z])/,'\1_\2').downcase
-  
-  filename = "#{app_dir}/entities/#{snake_name}.rb"
-  File.open(filename, 'w') {|f| f.write(output) }
-
-  output = <<FIN
-require_relative '../../entities/#{snake_name}'
-
-describe #{name} do
-#{method_specs}
-end
-
-
-FIN
-  filename = "#{app_dir}/spec/entities/#{snake_name}_spec.rb"
-  File.open(filename, 'w') {|f| f.write(output) }
-
-
-  #puts output
-end
-
-
-
-jacks.each do |k, v|
-  
-  name = k.chomp('Jack').downcase
-
-  method_specs = ''
-  method_definitions = ''
-
-  v.each do |method|
-
-    method_definitions << "
-  def #{method}_contract input
-    input_shape = {}
-    output_shape = {}
-    call_method :#{method}_alias, input, input_shape, output_shape
-  end
-    " 
-
-    method_specs << "
-  describe '.#{method}_contract' do
-    it 'should #{method} data with valid input'
-
-    it 'should raise an error with invalid input'
-
-    it 'should raise an error with invalid output'
-
-  end
-    "
-    
-  end
-
-
-  output = <<FIN
-require 'obvious'
-   
-class #{k}Contract < Contract
-  def self.contracts
-    #{v.to_s}
-  end
-#{method_definitions} 
-end
-FIN
-
-  snake_name = name.gsub(/(.)([A-Z])/,'\1_\2').downcase
-  
-  filename = "#{app_dir}/contracts/#{snake_name}_jack_contract.rb"
-  File.open(filename, 'w') {|f| f.write(output) }
-
-  #puts output
-
-  output = <<FIN
-require_relative '../../contracts/#{snake_name}_jack_contract'
-
-describe #{k}Contract do
-#{method_specs} 
-end
-
-FIN
-
-  filename = "#{app_dir}/spec/contracts/#{snake_name}_jack_spec.rb"
-  File.open(filename, 'w') {|f| f.write(output) }
-
-  #puts output
-end
-
-
-
-
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: obvious
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-23 00:00:00.000000000 Z
+date: 2013-01-10 00:00:00.000000000 Z
 dependencies: []
 description: A set of tools to build apps using the Obvious Architecture
 email:
@@ -50,9 +50,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Isn't it Obvious?
 test_files: []
-has_rdoc: