xli-hickey 0.0.1

data/CHANGES

@@ -0,0 +1 @@
+= Hickey Changelog

data/LICENSE.TXT

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README

@@ -0,0 +1,115 @@
+= Hickey
+
+Supporting Hickey version: 0.0.x
+
+Hickey provides a simple way of preparing test data inside your test for Rails project.
+For making the process of preparing test data fast, Hickey will bypass all model validations
+and callbacks. Of course, your can enable them when you need.
+
+== Installation
+
+=== GEM Installation
+
+Run the following if you haven't already:
+
+  gem sources -a http://gems.github.com
+
+Install the gem:
+
+  sudo gem install xli-hickey
+  
+== Simple Examples
+
+=== Environment
+
+After installed hickey gem, require 'hickey' in your test environment.
+
+=== Create single model
+
+Suppose we have a User model that has attributes login and admin
+  % class User < ActiveRecord::Base
+  % end
+
+We can create a user model by the following code:
+  % Hickey.kiss(:user => {:login => 'xli', :admin => true})
+
+It's not the simplest way to create user model, but just let you know how it works.
+
+=== Create domain models
+
+Suppose we have the following models:
+  % class Project < ActiveRecord::Base
+  %   has_many :tags
+  %   has_many :cards
+  % end
+  %
+  % class Tag < ActiveRecord::Base
+  %   has_many :taggings, :class_name => '::Tagging'
+  %   belongs_to :project
+  % end
+  % 
+  % class Tagging < ActiveRecord::Base
+  %   belongs_to :tag
+  %   belongs_to :taggable, :polymorphic => true
+  % end
+  % 
+  % class Card < ActiveRecord::Base
+  %   has_many :taggings, :as => :taggable
+  %   belongs_to :project
+  % end
+
+We can create a domain in the test by the following code:
+  % Hickey.kiss :project => {
+  %   :identifier => 'hickey', :cards => [
+  %     {
+  %       :name => 'first card', 
+  %       :taggings => [{:tag => {:name => 'first_tag'}}],
+  %     },
+  %     {
+  %       :name => 'dont make me think',
+  %       :taggings => [{:tag => {:name => 'ignore me'}}]
+  %     }
+  %   ]
+  % }
+
+Another example for we want to create tag cards with one same tag named 'first_tag':
+  % Hickey.kiss :project => {
+  %   :identifier => 'hickey', :cards => [
+  %     {
+  %       :name => 'first card', 
+  %       :taggings => [{:tag => {:find_or_create => {:name => 'first_tag'}}}],
+  %     },
+  %     {
+  %       :name => 'dont make me think',
+  %       :taggings => [{:tag => {:find_or_create => {:name => 'first_tag'}}}]
+  %     }
+  %   ]
+  % }
+
+== License
+
+Hickey is available under an Apache License Version 2.0.
+
+== Support
+
+Feel free to submit commits or feature requests.  If you send a patch,
+remember to update the corresponding unit tests.  If fact, I prefer
+new feature to be submitted in the form of new unit tests.
+
+For other information, feel free to ask on the ruby-talk mailing list or contact
+mailto:iam@li-xiao.com.
+
+= Other stuff
+
+Author::  Li Xiao <iam@li-xiao.com>
+Requires:: Ruby 1.8.6 or later
+License::  Copyright 2008 by Li Xiao.
+           Released under an Apache License Version 2.0.  See the LICENSE file
+           included in the distribution.
+
+== Warranty
+
+This software is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantibility and fitness for a particular
+purpose.

data/Rakefile

@@ -0,0 +1,97 @@
+# Rakefile for Hickey        -*- ruby -*-
+
+# Copyright 2007 by Li Xiao (iam@li-xiao.com)
+# All rights reserved.
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/lib')
+require 'hickey'
+
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'rubygems'
+  require 'rake/gempackagetask'
+rescue Exception
+  nil
+end
+
+# The default task is run if rake is given no explicit arguments.
+
+desc "Default Task"
+task :default => :test_all
+
+# Common Abbreviations ...
+
+task :test_all => [:test_units]
+task :test => :test_units
+
+Rake::TestTask.new(:test_units) do |t|
+  t.test_files = FileList['test/*test.rb']
+  t.warning = false
+  t.verbose = false
+end
+
+# Create a task to build the RDOC documentation tree.
+
+rd = Rake::RDocTask.new("rdoc") { |rdoc|
+  rdoc.rdoc_dir = 'html'
+#  rdoc.template = 'kilmer'
+#  rdoc.template = 'css2'
+  rdoc.template = 'doc/jamis.rb'
+  rdoc.title    = "Hickey"
+  rdoc.options << '--line-numbers' << '--inline-source' <<
+    '--main' << 'README' <<
+    '--title' <<  'Hickey' 
+  rdoc.rdoc_files.include('README', 'LICENSE.txt', 'TODO', 'CHANGES')
+  rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
+}
+
+if ! defined?(Gem)
+  puts "Package Target requires RubyGEMs"
+else
+  File.open(File.dirname(__FILE__) + '/hickey.gemspec') do |f|
+    data = f.read
+    spec = nil
+    Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
+    package_task = Rake::GemPackageTask.new(spec) do |pkg|
+      #pkg.need_zip = true
+      #pkg.need_tar = true
+    end
+  end
+end
+
+# Misc tasks =========================================================
+
+def count_lines(filename)
+  lines = 0
+  codelines = 0
+  open(filename) { |f|
+    f.each do |line|
+      lines += 1
+      next if line =~ /^\s*$/
+      next if line =~ /^\s*#/
+      codelines += 1
+    end
+  }
+  [lines, codelines]
+end
+
+def show_line(msg, lines, loc)
+  printf "%6s %6s   %s\n", lines.to_s, loc.to_s, msg
+end
+
+desc "Count lines in the main MM file"
+task :lines do
+  total_lines = 0
+  total_code = 0
+  show_line("File Name", "LINES", "LOC")
+  FileList['lib/**/*.rb', 'lib/**/*.rake'].each do |fn|
+    lines, codelines = count_lines(fn)
+    show_line(fn, lines, codelines)
+    total_lines += lines
+    total_code  += codelines
+  end
+  show_line("TOTAL", total_lines, total_code)
+end

data/TODO

@@ -0,0 +1,53 @@
+= Hickey Project -- To Do List
+
+Send suggestions for this list to iam@li-xiao.com
+
+=== To Do
+  * auto create model associations by each_card_type:
+      property_definitions_card_types => [:each_card_type => {}]
+  * specify item type by key name inside array list example: property_definitions => [{:enum_prop_def => {:name => 'xx'}}]
+  * with scope
+    * scope with user defined foreign_key id inside of model
+  * Single table inheritance
+    * has one
+    * belongs_to
+    * has_and_belongs_to_many
+  * log of creating domain progress for problem detecting
+  * auto_generate_position_for_model_acts_as_list
+  * prepare multi-models domain
+    * :source, :source_type options in has_many :through
+  * enable validations
+  * composed_of
+  * prepare with model validation
+  * should be in transaction?
+  * fast prepare by sql? really need it?
+  * enable callbacks
+    * enable specific method of callbacks?
+=== Done
+  * prepare model data should not trigger any callback
+  * prepare model with attributes
+  * prepare multi-models domain
+    * prepare has_many relationship models
+    * prepare belongs_to relationship models
+    * prepare belongs_and_has_many relationship models
+    * specify class by :class_name
+      * has_one
+      * has_and_belongs_to_many
+      * has_many
+      * belongs_to
+    * :through in has_one
+    * polymorphic
+    * foreign_key
+  * Single table inheritance
+    * has many
+  * enable callbacks
+    * enable all callbacks
+    * enable specific callbacks
+  * actions: find or create
+    * find
+    * create as default
+    * find_or_create
+  * with scope
+    * simple scope with default model foreign_key id inside of model
+
+(moved DONE list to CHANGES file)

data/hickey.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  
+  #### Basic information.
+
+  s.name = 'hickey'
+  s.version = '0.0.1'
+  s.summary = "Hickey provides a simple way of preparing test data inside test for Rails project."
+
+  s.add_dependency('activerecord', '>= 2.1.0')
+  #### Which files are to be included in this gem?  Everything!  (Except SVN directories.)
+  # p Dir.glob("lib/**/*.rb") + Dir.glob("test/**/*.rb")
+  s.files = ["lib/hickey/acceptor.rb", "lib/hickey/domain_detector/actions.rb", "lib/hickey/domain_detector/associations.rb", "lib/hickey/domain_detector/base.rb", "lib/hickey/domain_detector/configurable.rb", "lib/hickey/domain_detector/scopes.rb", "lib/hickey/domain_detector.rb", "lib/hickey.rb", "test/belongs_to_association_test.rb", "test/database_config.rb", "test/enable_callbacks_test.rb", "test/find_or_create_actions_test.rb", "test/has_and_belongs_to_many_association_test.rb", "test/has_many_association_test.rb", "test/has_one_association_test.rb", "test/model_association_test.rb", "test/models/address.rb", "test/models/author.rb", "test/models/country.rb", "test/models/project.rb", "test/models/projects_member.rb", "test/models/property_definition.rb", "test/models/simple.rb", "test/models/tag.rb", "test/models/topic.rb", "test/models/user.rb", "test/models/writer.rb", "test/schema.rb", "test/single_model_test.rb", "test/test_helper.rb", "test/with_scope_test.rb"] + ["CHANGES", "hickey.gemspec", "LICENSE.TXT", "Rakefile", "README", "TODO"]
+
+  #### Load-time details: library and application (you will need one or both).
+
+  s.require_path = 'lib'                         # Use these for libraries.
+
+  #### Documentation and testing.
+
+  s.has_rdoc = false
+
+  #### Author and project details.
+  s.author = "Li Xiao"
+  s.email = "iam@li-xiao.com"
+  s.homepage = "https://github.com/xli/hickey/tree"
+end

data/lib/hickey/acceptor.rb

@@ -0,0 +1,25 @@
+module Hickey
+  module Acceptor
+    module Hash
+      def accept_for_hickey(klass, visitor)
+        visitor.visit_hash(klass, self)
+      end
+    end
+    module Array
+      def accept_for_hickey(klass, visitor)
+        collect do |o|
+          o.accept_for_hickey(klass, visitor)
+        end
+      end
+    end
+    module ReturnSelf
+      def accept_for_hickey(klass, visitor)
+        self
+      end
+    end
+  end
+end
+
+Array.send(:include, Hickey::Acceptor::Array)
+Hash.send(:include, Hickey::Acceptor::Hash)
+ActiveRecord::Base.send(:include, Hickey::Acceptor::ReturnSelf)

data/lib/hickey/domain_detector/actions.rb

@@ -0,0 +1,38 @@
+module Hickey
+  module DomainDetector
+    module Actions
+      def self.included(base)
+        base.send(:alias_method_chain, :visit_hash, :find_or_create_actions)
+      end
+      
+      def visit_hash_with_find_or_create_actions(attribute, record)
+        case record.keys.first
+        when :find
+          record = record[:find]
+          attribute = find_action(attribute, record)
+        when :create
+          record = record[:create]
+        when :find_or_create
+          record = record[:find_or_create]
+          if find_attribute = find_action(attribute, record)
+            attribute = find_attribute
+          end
+        end
+        visit_hash_without_find_or_create_actions(attribute, record)
+      end
+      
+      def find_action(attribute, record)
+        model_type = compute_type(attribute, record)
+        conditions = record.inject({}) do |c, entity|
+          key, value = entity
+          unless [Hash, Array].include?(value.class)
+            #added if to filter column name for fixing hickey on acitverecord 1.2.6
+            c[key] = value if model_type.column_names.include?(key.to_s)
+          end
+          c
+        end
+        compute_type(attribute, record).find(:first, :conditions => conditions)
+      end
+    end
+  end
+end

data/lib/hickey/domain_detector/associations.rb

@@ -0,0 +1,80 @@
+module Hickey
+  module DomainDetector
+    module BelongsToAssociation
+      def belongs_to(owner, reflection, attr_value)
+        association = attr_value.accept_for_hickey(reflection.klass, self)
+        owner.send("#{reflection.primary_key_name}=", association.id)
+        Proc.new{}
+      end
+    end
+    
+    module HasOneAssociation
+      def has_one(owner, reflection, attr_value)
+        return has_one_through(owner, reflection, attr_value) if reflection.through_reflection
+
+        Proc.new do
+          attr_value[reflection.primary_key_name] = owner.id
+          if reflection.options[:as]
+            attr_value["#{reflection.options[:as]}_type"] = owner.class.base_class.name.to_s
+          end
+          attr_value.accept_for_hickey(reflection.klass, self)
+        end
+      end
+    end
+    
+    module HasOneThroughAssociation
+      def has_one_through(owner, reflection, attr_value)
+        through_reflection = reflection.through_reflection
+        Proc.new do
+          target = attr_value.accept_for_hickey(reflection.klass, self)
+          association = ActiveRecord::Associations::HasOneThroughAssociation.new(owner, reflection).send(:construct_join_attributes, target)
+          association.accept_for_hickey(through_reflection.klass, self)
+        end
+      end
+    end
+    
+    module HasManyAssociation
+      def has_many(owner, reflection, attr_value)
+        return has_many_through(owner, reflection, attr_value) if reflection.through_reflection
+
+        Proc.new do
+          attr_value.each do |obj|
+            obj[reflection.primary_key_name] = owner.id
+            if reflection.options[:as]
+              obj["#{reflection.options[:as]}_type"] = owner.class.base_class.name.to_s
+            end
+          end
+          attr_value.accept_for_hickey(reflection.klass, self)
+        end
+      end
+    end
+    
+    module HasManyThroughAssociation
+      def has_many_through(owner, reflection, attr_value)
+        through_reflection = reflection.through_reflection
+        Proc.new do
+          owner_associations = owner.send(reflection.name)
+          target = attr_value.accept_for_hickey(reflection.klass, self)
+          target.each do |record|
+            association = owner_associations.send(:construct_join_attributes, record)
+            proxy = through_reflection.klass.send(:with_scope, :create => association) do
+              visit_hash(through_reflection.klass, {})
+            end
+            owner_associations.proxy_target << proxy
+          end
+        end
+      end
+    end
+    
+    module HasAndBelongsToManyAssociation
+      def has_and_belongs_to_many(owner, reflection, attr_value)
+        association = attr_value.accept_for_hickey(reflection.klass, self)
+        Proc.new do
+          association.each do |record|
+            owner.send(reflection.name).send(:insert_record, record)
+          end
+        end
+      end
+    end
+  end
+end