whorm 0.4.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Chris Scott
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,113 @@
+= mvc
+
+A simple Model mixin with adapters for various ORM frameworks such as ActiveRecord, DataMapper and MongoMapper.  Whorm was originally created as part of the gem extjs-mvc[http://github.com/extjs/mvc] to assist with auto-generating ExtJS Stores (Ext.data.Store).  However, it can be useful for a variety of Javascript frameworks for rendering data on the client.
+
+
+===Installation
+	% sudo gem install gemcutter
+	% sudo gem install whorm
+
+
+=== An ORM Model mixin:  Whorm::Model
+whorm contains Model mixin named <tt>Whorm::Model</tt> which works for <b>three</b> popular ORM frameworks, ActiveRecord, DataMapper and MongoMapper.  The API for each framework is identical and an adapter can be created for just about any
+ORM in about an hour.
+
+Simply include the mixin into your model.  Use the class-method <tt>whorm_fields</tt> to specify those
+fields with will be used to render a record to Hash for later JSON-encoding.
+
+  class User < ActiveRecord::Base
+    include Whorm::Model
+
+    whorm_fields :exclude => [:password, :password_confirmation]
+    
+    # OR 
+    whorm_fields :name, :description
+    
+    # OR
+    whorm_fields :only => [:name, :description] # actually the same as above
+    
+    # OR
+    whorm_fields :additional => [:computed] # includes all database columns and an additional computed field
+    
+    # OR define a column as a Hash
+    whorm_fields :description, :name => {"sortDir" => "ASC"}, :created_at => {"dateFormat" => "c"}
+	
+    # OR render associations, association-fields will have their "mapping" property set automatically
+    whorm_fields :name, :description, :company => [:name, :description]
+    
+    def computed
+      name.blank? ? login : name
+    end
+  end
+
+After including the model mixin <tt>ExtJS::Model</tt>, try typing the following in <tt>irb</tt> console:
+    >> User.whorm_schema
+    => { :idProperty=>"id", :fields=>[
+         {:type=>'int', :allowBlank=>true, :name=>"id"},
+         {:type=>'string', :allowBlank=>false, :name=>"first", :defaultValue => nil},
+         {:type=>'string', :allowBlank=>false, :name=>"last", :defaultValue => nil},
+         {:type=>'string', :allowBlank=>false, :name=>"email", :defaultValue => nil}
+       ]}
+
+An auto-generated <tt>Ext.data.JsonReader</tt> configuration!
+
+
+You can also define different sets of fields for different representations of your model.
+
+E.g. with the following definition:
+
+    class User < ActiveRecord::Base
+      include ExtJS::Model
+
+      whorm_fieldset :grid, fields => [:name, :description, :company => [:name, :description]]
+      whorm_fieldset :combo, [:full_name]
+  
+      def full_name
+        "#{first_name} #{name}"
+      end
+    end
+
+You can get store configs for both representations with
+    User.whorm_schema(:grid)
+or
+    User.whorm_schema(:combo)
+    
+And the corresponding data for the representations with
+    User.first.to_record(:grid)
+or
+    User.first.to_record(:combo)
+
+=== A Testing Mixin:  Whorm::TestMacros
+The <tt>whorm</tt> Gem includes a small set of testing macros to help unit-test models.
+This requires the 'Shoulda' gem from thoughtbot.  Include this mixin inside the
+<tt>ActiveSupport::TestCase</tt> class in <tt>test/test_helper.rb</tt>
+
+==== Usage
+<tt>test/test_helper.rb</tt>
+    class ActiveSupport::TestCase
+      extend Whorm::TestMacros
+      #...
+    end
+
+In individual model unit tests:
+    class ModelTest < ActiveSupport::TestCase
+      should_require_whorm_fields :name, :email, :city
+      #...
+      #other tests
+    end
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+  bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Chris Scott. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,64 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "whorm"
+    gem.summary = %Q{Ruby ORM-inspecting tools to assist with generating JSON representations of database schemas and recordsets.}
+    gem.description = %Q{Whorm contains a Model-mixin named Whorm::Model.  Once included, your Model now exposes a class-method named #whorm_schema which will return Hash representation of the Model-schema.}
+    gem.email = "christocracy@gmail.com"
+    gem.homepage = "http://github.com/christocracy/whorm"
+    gem.authors = ["Chris Scott"]
+    gem.add_development_dependency "shoulda"
+    gem.add_development_dependency "mocha"
+    gem.add_development_dependency "extlib"
+    
+    gem.test_files = []
+    gem.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*", 'lib/jeweler/templates/.gitignore']
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mvc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/lib/test/macros.rb

@@ -0,0 +1,20 @@
+module ExtJS
+  module TestMacros
+    ##
+    # Asserts that the passed list of fields are specified in the extjs_fields call
+    # in the model class.
+    # @fields {Symbols} fields A list of fields
+    #
+    def should_have_extjs_fields *fields
+      klass = model_class
+      should "have the correct extjs_fields" do
+        fields.each do |field|
+          found_record = klass.extjs_record_fields.find do|record_field|
+            record_field[:name] == field.to_s
+          end
+          assert_not_nil found_record, "extjs field #{field} isn't listed in the #{klass.name} model"
+        end
+      end
+    end
+  end
+end

data/lib/whorm.rb

@@ -0,0 +1,15 @@
+require 'whorm/model'
+
+# Detect orm, include appropriate mixin.
+if defined?(ActiveRecord)
+  require 'whorm/adapters/active_record'
+elsif defined?(DataMapper)
+  require 'whorm/adapters/data_mapper'
+elsif defined?(MongoMapper)
+  require 'whorm/adapters/mongo_mapper'
+end
+
+module Whorm
+  VERSION = "0.4.0"
+end
+

data/lib/whorm/adapters/active_record.rb

@@ -0,0 +1,88 @@
+##
+# ActiveRecord adapter to Whorm::Model mixin.
+#
+module Whorm
+  module Model
+    module ClassMethods
+      def whorm_primary_key
+        self.primary_key.to_sym
+      end
+      
+      def whorm_column_names
+        self.column_names.map(&:to_sym)
+      end
+      
+      def whorm_columns_hash
+        self.columns_hash.symbolize_keys
+      end
+      
+      ##
+      # determine if supplied Column object is nullable
+      # @param {ActiveRecord::ConnectionAdapters::Column}
+      # @return {Boolean}
+      #
+      def whorm_allow_blank(col)
+        # if the column is the primary key always allow it to be blank.
+        # Otherwise we could not create new records with whorm because
+        # new records have no id and thus cannot be valid
+        col.name == self.primary_key || col.null
+      end
+      
+      ##
+      # returns the default value
+      # @param {ActiveRecord::ConnectionAdapters::Column}
+      # @return {Mixed}
+      #
+      def whorm_default(col)
+        col.default
+      end
+      
+      ##
+      # returns the corresponding column name of the type column for a polymorphic association
+      # @param {String/Symbol} the id column name for this association
+      # @return {Symbol}
+      def whorm_polymorphic_type(id_column_name)
+        id_column_name.to_s.gsub(/_id\Z/, '_type').to_sym
+      end
+      
+      ##
+      # determine datatype of supplied Column object
+      # @param {ActiveRecord::ConnectionAdapters::Column}
+      # @return {String}
+      #
+      def whorm_type(col)
+        type = col.type.to_s
+        case type
+          when "datetime", "date", "time", "timestamp"
+            type = "date"
+          when "text"
+            type = "string"
+          when "integer"
+            type = "int"
+          when "decimal"
+            type = "float"
+        end
+        type
+      end
+      
+      ##
+      # return a simple, normalized list of AR associations having the :name, :type and association class
+      # @return {Array}
+      #
+      def whorm_associations
+        @whorm_associations ||= self.reflections.inject({}) do |memo, (key, assn)|
+          type = (assn.macro === :has_many || assn.macro === :has_and_belongs_to_many) ? :many : assn.macro
+          memo[key.to_sym] = {
+            :name => key.to_sym, 
+            :type => type, 
+            :class => assn.options[:polymorphic] ? nil : assn.class_name.constantize,
+            :foreign_key => assn.association_foreign_key.to_sym,
+            :is_polymorphic => !!assn.options[:polymorphic]
+          }
+          memo
+        end
+      end
+    end
+  end
+end
+

data/lib/whorm/adapters/data_mapper.rb

@@ -0,0 +1,66 @@
+##
+# DataMapper adapter for Whorm::Model mixin
+#
+
+module Whorm
+  module Model
+    module ClassMethods
+      
+      def whorm_primary_key
+        self.key.first.name
+      end
+      
+      def whorm_column_names
+        self.properties.collect {|p| p.name.to_s }
+      end
+      
+      def whorm_columns_hash
+        if @whorm_columns_hash.nil?
+          @whorm_columns_hash = {}
+          self.properties.each do |p|
+            @whorm_columns_hash[p.name] = p
+          end
+        end
+        @whorm_columns_hash
+      end
+      
+      def whorm_allow_blank(col)
+         (col === self.key.first) ? true : col.nullable?
+      end
+      
+      def whorm_type(col)
+        type = ((col.type.respond_to?(:primitive)) ? col.type.primitive : col.type).to_s
+        case type
+          when "DateTime", "Date", "Time"
+            type = :date
+          when "String"
+            type = :string
+          when "Float"
+            type = :float
+          when "Integer", "BigDecimal"
+            type = :int
+          else
+            type = "auto"
+        end
+      end
+      
+      def whorm_associations
+        if @whorm_associations.nil?  
+          @whorm_associations = {}
+          self.relationships.keys.each do |key|
+            assn = self.relationships[key]
+            @whorm_associations[key.to_sym] = {
+              :name => key, 
+              :type => type = (assn.options[:max].nil? && assn.options[:min].nil?) ? :belongs_to : (assn.options[:max] > 1) ? :many : nil ,
+              :class => assn.parent_model,
+              :foreign_key => assn.child_key.first.name,
+              :is_polymorphic => false # <-- No impl. for DM is_polymorphic.  Anyone care to implement this?
+            }
+          end
+        end
+        @whorm_associations
+      end
+    end
+  end
+end
+

data/lib/whorm/adapters/mongo_mapper.rb

@@ -0,0 +1,64 @@
+##
+# MongoMapper adapter to Whorm::Model mixin
+#
+    
+module Whorm
+  module Model
+    ##
+    # ClassMethods
+    #
+    module ClassMethods
+
+      def whorm_primary_key
+        :id
+      end
+
+      def whorm_column_names
+        self.column_names
+      end
+
+      def whorm_columns_hash
+        self.keys
+      end
+
+      def whorm_associations
+        @whorm_associations ||= self.associations.inject({}) do |memo, (key, assn)|
+          memo[key.to_sym] = {
+            :name => key.to_sym,
+            :type => assn.type,
+            :class => assn.class_name.constantize,
+            :foreign_key => assn.foreign_key,
+            :is_polymorphic => false
+          }
+          memo
+        end
+      end
+
+      def whorm_type(col)
+        type = col.type.to_s
+        case type
+          when "DateTime", "Date", "Time"
+            type = :date
+          when "String"
+            type = :string
+          when "Float"
+            type = :float
+          when "Integer", "BigDecimal"
+            type = :int
+          else
+            type = "auto"
+        end
+      end
+
+      def whorm_allow_blank(col)
+        (col.name == '_id') || (col.options[:required] != true)
+      end
+      
+      def whorm_default(col)
+        col.default_value
+      end
+      
+    end
+  end
+end
+