obvious 0.0.3 → 0.0.5

data/bin/obvious

@@ -2,293 +2,6 @@
 
 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
+  Obvious::Generators::ApplicationGenerator.generate
 end
-
-
-

data/lib/generators/application_generator.rb

@@ -0,0 +1,159 @@
+require 'yaml'
+
+require_relative 'helpers/application'
+require_relative 'descriptor'
+
+module Obvious
+  module Generators
+    class ApplicationGenerator
+      class << self
+        def generate
+          @app = Obvious::Generators::Application.instance
+
+          puts 'Generating the files...'
+
+          Obvious::Generators::ApplicationGenerator.create_directories ['/', '/actions', '/contracts', '/entities',
+            '/spec', '/spec/actions', '/spec/contracts', '/spec/entities',
+            '/spec/doubles']
+
+          unless File.exist? "#{@app.target_path}/Rakefile" 
+            puts 'Creating Rakefile...'
+            `cp #{@app.lib_path}/obvious/files/Rakefile #{@app.target_path}/Rakefile`
+          end
+
+          unless File.exist? "#{@app.target_path}/external"
+            puts 'Creating external directory'
+            `cp -r #{@app.lib_path}/obvious/files/external #{@app.target_path}/external`
+          end
+
+          descriptors = Dir['descriptors/*.yml']
+
+          puts 'Creating actions from descriptors... ' unless descriptors.length.zero?
+          descriptors.each do |file|
+            descriptor = Obvious::Generators::Descriptor.new file
+            descriptor.to_file
+          end
+
+          @app.remove_duplicates
+
+          puts 'Writing Entities scaffolds... '
+          Obvious::Generators::ApplicationGenerator.write_entities
+
+          puts 'Writing jacks scaffolds... '
+          Obvious::Generators::ApplicationGenerator.write_jacks
+
+          puts "Files are located in the `#{@app.dir}` directory."
+        end # ::generate
+
+        def create_directories directories
+          directories.each do |dir|
+            Dir.mkdir @app.dir + dir
+          end
+        end
+
+        def write_entities
+          @app.entities.each do |k, v|
+            name          = k
+            method_specs  = ''
+            method_defs   = ''
+
+            method_defs << '
+  def self.shape
+    {}
+  end
+  '
+
+            v.each do |method|
+              method_defs << "
+  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 = %Q{class #{name}
+  #{method_defs}
+end
+}
+            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 = %Q{require_relative '../../entities/#{snake_name}'
+
+describe #{name} do
+  #{method_specs}
+end
+}
+
+            filename = "#{@app.dir}/spec/entities/#{snake_name}_spec.rb"
+            File.open(filename, 'w') {|f| f.write(output) }
+          end
+        end #write_entities
+
+        def write_jacks
+          @app.jacks.each do |k, v|
+            name         = k.chomp('Jack').downcase
+            method_specs = ''
+            method_defs  = ''
+
+            v.each do |method|
+
+              method_defs << "
+  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 = %Q{require 'obvious'
+
+class #{k}Contract < Contract
+  contracts :#{ v.join(', :')}
+  #{method_defs}
+end
+}
+
+            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) }
+
+            output = %Q{require_relative '../../contracts/#{snake_name}_jack_contract'
+
+describe #{k}Contract do
+  #{method_specs}
+end
+}
+
+            filename = "#{@app.dir}/spec/contracts/#{snake_name}_jack_spec.rb"
+            File.open(filename, 'w') {|f| f.write(output) }
+          end
+        end # generate_jacks_code
+      end
+    end
+  end
+end

data/lib/generators/descriptor.rb

@@ -0,0 +1,107 @@
+require 'yaml'
+
+require_relative 'helpers/application'
+
+module Obvious
+  module Generators
+    class Descriptor
+      def initialize descriptor
+        @descriptor = descriptor
+      end
+
+      def to_file
+        action = YAML.load_file @descriptor
+        @jacks, @entities = {}, {}
+        @code = ''
+
+        action['Code'].each do |entry|
+          write_comments_for entry
+          process_requirements_for entry if entry['requires']
+        end
+
+        write_action action
+      end
+
+      private
+      def write_comments_for entry
+        @code << "    \# #{entry['c']}\n"
+        @code << "    \# use: #{entry['requires']}\n" if entry['requires']
+        @code << "    \n"
+      end
+
+      def process_requirements_for entry
+        app      = Obvious::Generators::Application.instance
+        requires = entry['requires'].split ','
+
+        requires.each do |req|
+          req.strip!
+          infos = req.split '.'
+
+          if infos[0].index 'Jack'
+            app.jacks[infos[0]] = [] unless app.jacks[infos[0]]
+            @jacks[infos[0]]    = [] unless @jacks[infos[0]]
+
+            app.jacks[infos[0]] << infos[1]
+            @jacks[infos[0]] << infos[1]
+          else
+            app.entities[infos[0]] = [] unless app.entities[infos[0]]
+            @entities[infos[0]]    = [] unless @entities[infos[0]]
+
+            app.entities[infos[0]] << infos[1]
+            @entities[infos[0]] << infos[1]
+          end
+        end
+      end # #process_requirements_for
+
+      def write_action action
+        jacks_data   = process_jacks
+        requirements = require_entities
+
+        output = %Q{#{requirements}
+class #{action['Action']}
+
+  def initialize #{jacks_data[:inputs]}
+#{jacks_data[:assignments]}  end
+
+  def execute input
+#{@code}  end
+end
+}
+
+        snake_name = action['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) }
+      end
+
+      def process_jacks
+        jack_inputs = ''
+        jack_assignments = ''
+
+        @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! ', '
+
+        {
+          inputs: jack_inputs,
+          assignments: jack_assignments
+        }
+      end
+
+      def require_entities
+        entity_requires = ''
+
+        @entities.each do |k, v|
+          name = k.downcase
+          entity_requires << "require_relative '../entities/#{name}'\n"
+        end
+
+        entity_requires
+      end
+    end # ::Descriptor
+  end
+end

data/lib/generators/helpers/application.rb

@@ -0,0 +1,47 @@
+require 'singleton'
+
+module Obvious
+  module Generators
+    class Application
+      include Singleton
+
+      attr_reader :jacks, :entities, :dir
+
+      def initialize
+        @dir = 'app'
+
+        counter = 1
+        while File.directory? @dir
+          @dir = "app_#{counter}"
+          counter += 1
+        end
+      end
+
+      def jacks
+        @jacks ||= {}
+      end
+
+      def entities
+        @entities ||= {}
+      end
+
+      def target_path
+        File.realpath Dir.pwd
+      end
+
+      def lib_path
+        Gem::Specification.find_by_name("obvious").gem_dir + '/lib'
+      end
+
+      def remove_duplicates
+        entities.each do |k, v|
+          v.uniq!
+        end
+
+        jacks.each do |k,v|
+          v.uniq!
+        end
+      end
+    end # ::Application
+  end
+end

data/lib/obvious.rb

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

data/lib/obvious/contract.rb

@@ -20,7 +20,7 @@ class Contract
   #
   # Returns Nothing.
   def self.contracts *contracts
-     singleton_class.send :define_method, :contract_list do
+    singleton_class.send :define_method, :contract_list do
       contracts
     end
   end

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

@@ -0,0 +1,94 @@
+require 'json'
+
+class FsPlug 
+
+  def initialize filename
+    @filename = filename
+  end
+
+  def save input
+    # open the file
+    contents = File.read @filename
+
+    data = []
+    # parse the json list
+    query = JSON.parse contents, :symbolize_names => true
+
+    new_element = true if input[:id] == -1 # by convention set new element flag if id == -1
+
+    max_id = -1
+    # transform the data if needed
+    query.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 
+    input[:id] = max_id + 1
+    data << input if new_element
+
+    # save the data back to FS
+    json_data = JSON.pretty_generate data 
+    File.open(@filename, 'w') {|f| f.write(json_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 
+  end
+  
+  def get input
+    # open the file
+    contents = File.read @filename
+
+    data = []
+    # parse the json list
+    query = JSON.parse contents, :symbolize_names => true
+
+    # transform the data if needed
+    query.each do |h|
+      return h if h[:id] == input[:id]
+    end 
+
+    {} 
+  end
+
+  def remove input
+    # open the file
+    contents = File.read @filename
+
+    data = []
+    # parse the json list
+    query = JSON.parse contents, :symbolize_names => true
+
+    # transform the data if needed
+    query.each do |h|
+      unless h[:id] == input[:id]
+        data << h 
+      end
+    end
+
+    # save the data back to FS
+    json_data = JSON.pretty_generate data 
+    File.open(@filename, 'w') {|f| f.write(json_data) }
+
+    # return true on success
+    true 
+  end
+
+end
+
+
+

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

@@ -0,0 +1,57 @@
+require 'moped'
+
+class MongoPlug
+  def initialize collection
+    @collection = collection
+    @session = MONGO_SESSION
+  end
+
+  def list
+    result = @session[@collection].find.entries
+    result.map! do |entry|
+      clean_up entry 
+    end
+
+    result
+  end
+
+  def get input
+    result = symbolize_keys @session[@collection].find(:id => input[:id]).first
+    clean_up result
+  end
+
+  def save input
+    if input[:id] == -1
+      id = @session[:counters].find(:_id => @collection).modify({ "$inc" => { seq: 1 } }, new:true)["seq"]
+      input[:id] = id
+    end
+    result = @session[@collection].find(:id => input[:id]).modify(input, upsert: true, new: true)
+    clean_up result
+  end
+
+  def remove input
+    @session[@collection].find(:id => input[:id]).remove
+    true
+  end
+
+  def clean_up input
+    result = symbolize_keys input
+    result.delete :_id
+    result
+  end
+
+  def symbolize_keys hash
+    hash.inject({}){|result, (key, value)|
+      new_key = case key
+                when String then key.to_sym
+                else key
+                end
+      new_value = case value
+                  when Hash then symbolize_keys(value)
+                  else value
+                  end
+      result[new_key] = new_value
+      result
+    }
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'sequel'
+
+# assume that DB is defined as a global constant elsewhere
+
+class MysqlPlug 
+
+  def initialize table
+    @table = table
+  end
+
+  def save input
+    table = DB[@table]
+    input[:id] = nil if input[:id] == -1
+
+    # this does an upsert
+    result = table.on_duplicate_key_update.insert input
+
+    input[:id] = result
+    input
+  end
+
+  def list
+    table = DB[@table]
+    table.all
+  end
+
+  def get input
+    table = DB[@table]
+    table.first :id => input[:id]
+  end
+
+  def remove input
+    table = DB[@table]
+    result = table.where(:id => input[:id]).delete
+    return true if result == 1
+    false
+  end
+end

data/lib/obvious/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: obvious
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-10 00:00:00.000000000 Z
+date: 2013-01-14 00:00:00.000000000 Z
 dependencies: []
 description: A set of tools to build apps using the Obvious Architecture
 email:
@@ -25,9 +25,15 @@ files:
 - 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/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/version.rb
 - obvious.gemspec
 homepage: http://obvious.retromocha.com/
@@ -50,8 +56,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Isn't it Obvious?
 test_files: []
+has_rdoc: