famili 0.0.1

data/README.rdoc

@@ -0,0 +1,86 @@
+== Famili
+
+Yet Another ObjectMother pattern implementation for rails testing
+
+== Why
+  
+We meet some problems with factory-girl:
+
+* We require quite complex logic for creation of test models
+* We require use factories with running rails application for integration tests 
+* So why don't make factory just another class in rails lib ?
+
+== Example  
+
+To define factory/mother for model User just create class in your lib directory:
+
+ `lib/famili/user.rb`
+
+ module Famili
+    class User < Mother
+      fist_name { 'nicola' }
+      last_name { 'nicola' }
+      email     { "#{last_name}@mail.lv" } 
+
+      def before_save(user)
+          #...
+      end
+
+      def after_create(user)
+          #...
+      end
+    end
+  end
+
+
+And u can use it anywhere in tests or controllers:
+  
+ Famili::User.create(:fist_name=>'Override') # create model
+ Famili::User.build(:fist_name=>'Override')  # build model not saving
+ Famili::User.hash(:fist_name=>'Override')   #get attributes hash 
+
+== Install
+
+in config/environment.rb:
+
+ config.gem 'famili'
+
+and then 
+
+ sudo rake gems:install
+
+== FEATURES
+
+
+== CHANGE LOG:
+
+0.0.1  - created 
+
+== TODO 
+
+* generators 
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 niquola
+
+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/Rakefile

@@ -0,0 +1,48 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the pg_gnostic plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the pg_gnostic plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Famili'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+PKG_FILES = FileList[ '[a-zA-Z]*', 'generators/**/*', 'lib/**/*', 'spec/**/*' ]
+
+require 'lib/famili'
+spec = Gem::Specification.new do |s|
+  s.name = "famili"
+  s.version = Famili::VERSION 
+  s.author = "niquola"
+  s.email = "niquola@gmail.com"
+  s.homepage = "http://github.com/niquola/famili"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Rails plugin for postgres"
+  s.files = PKG_FILES.to_a 
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README.rdoc"]
+end
+
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+

data/lib/famili/mother.rb

@@ -0,0 +1,107 @@
+module  Famili
+  def before_save(model)
+  end
+
+  def after_create(model)
+  end
+
+  class Mother
+    class << self
+      alias :class_name :name
+
+      def parent_class=(klass)
+        @parent_class = klass
+      end
+
+      def parent_class
+        @parent_class
+      end
+
+      def inherited(child)
+        child.parent_class = self
+      end
+
+      def name(&block)
+        field(:name,&block)
+      end
+
+      def method_missing(method,&block)
+        field(method,&block)
+      end
+
+      def attribures
+        @attribures||=parent_class && parent_class.attribures
+        @attribures||=[]
+        @attribures.uniq!
+        @attribures
+      end
+
+      def field(method,&block)
+        attribures<< method
+        #puts "define_method #{method} #{self}"
+        define_method(method,&block) if block_given?
+      end
+
+      def create(opts={})
+        mother,model = _build(opts)
+        model.save
+        mother.after_create(model)
+        model
+      end
+
+      def build(opts={})
+        mother,model = _build(opts)
+        model
+      end
+
+      def hash
+        mother,model = _build
+        model.attribures
+      end
+
+
+      def _build(opts)
+        mother = new
+        model = model_class.new
+        opts.symbolize_keys!
+        passed_attrs = opts.keys  || []
+
+        mother.instance_eval do
+          singleton = class <<self;self;end;
+          passed_attrs.each do |attr|
+            value = opts[attr]
+            if value.class == Proc
+              singleton.send(:define_method,attr,&value)
+            else
+              singleton.send(:define_method,attr) do
+                opts[attr]
+              end
+            end
+          end
+      end
+
+      fields = ( passed_attrs + attribures).uniq
+      fields.each do |attr|
+        attr = attr.to_sym
+        value = opts.key?(attr) ?  opts[attr] : mother.send(attr)
+        model.send(:"#{attr}=",value)
+      end
+      mother.before_save(model)
+      [mother,model]
+    end
+
+    private
+
+    def model_class(klass=nil)
+      if klass 
+        @model_class = klass
+        return
+      end
+
+      @model_class||= class_name.to_s.split('::')[1..-1].inject(Object) do |mod,const| 
+        mod.const_get(const)
+      end
+    end
+  end
+end
+end

data/lib/famili.rb

@@ -0,0 +1,5 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+module Famili
+  VERSION='0.0.1'
+  autoload :Mother,'famili/mother'
+end

data/spec/database.yml

@@ -0,0 +1,6 @@
+adapter: postgresql
+host: localhost
+database: famili
+username: postgres
+password: postgres
+encoding: utf8

data/spec/db/schema.rb

@@ -0,0 +1,15 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users do |t|
+    t.string   :last_name,                 :limit => 25
+    t.string   :first_name,                :limit => 25
+    t.string   :middle_name,               :limit => 25
+    t.string   :name,                      :limit => 25
+    t.string   :login,                     :limit => 40
+    t.string   :email,                     :limit => 100
+    t.string   :crypted_password,          :limit => 40
+    t.string   :salt,                      :limit => 40
+    t.datetime :last_login_datetime
+    t.datetime :deleted_at
+    t.timestamps
+  end
+end

data/spec/famili_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Famili do
+  before :all do
+    TestDbUtils.ensure_schema
+  end
+
+  after :all do
+    #TestDbUtils.drop_database
+  end
+
+  class User < ActiveRecord::Base
+  end
+
+  module Famili
+    class User < Mother
+      last_name { 'nicola' }
+
+      def before_save(user)
+        user.first_name = 'first_name' 
+      end
+
+      def after_create(model)
+      end
+    end
+  end
+
+  it "should create model" do
+    nicola = Famili::User.create 
+    nicola.class.should == User
+    nicola.last_name.should == 'nicola'
+    nicola.first_name.should == 'first_name'
+
+    ivan = Famili::User.create(:name=>'ivan')
+    ivan.name.should == 'ivan'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'active_record'
+
+
+def path(path)
+  File.join(File.dirname(__FILE__),path)
+end
+
+$:.unshift(path('../lib'))
+require 'famili'
+
+class TestDbUtils
+  class<< self
+    def config
+      @config ||= YAML::load(IO.read(path('/database.yml'))).symbolize_keys
+    end
+
+    #create test database
+    def ensure_test_database
+      connect_to_test_db
+    rescue
+      create_database
+    end
+
+    def load_schema
+      ensure_test_database
+      load(path('db/schema.rb'))
+    end
+
+    def ensure_schema
+      load_schema
+    rescue
+      puts "tests database exists: skip schema loading"
+    end
+
+    def create_database
+      connect_to_postgres_db
+      ActiveRecord::Base.connection.create_database(config[:database], config)
+      connect_to_test_db
+    rescue
+      $stderr.puts $!, *($!.backtrace)
+      $stderr.puts "Couldn't create database for #{config.inspect}"
+    end
+
+    def connect_to_test_db
+      ActiveRecord::Base.establish_connection(config)
+      ActiveRecord::Base.connection
+    end
+
+    def connect_to_postgres_db
+      ActiveRecord::Base.establish_connection(config.merge(:database => 'postgres', :schema_search_path => 'public'))
+    end
+
+    def drop_database
+      connect_to_postgres_db
+      ActiveRecord::Base.connection.drop_database config[:database]
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: famili
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- niquola
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-29 00:00:00 +04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: niquola@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Rakefile
+- README.rdoc
+- lib/famili.rb
+- lib/famili/mother.rb
+- spec/famili_spec.rb
+- spec/spec_helper.rb
+- spec/database.yml
+- spec/db/schema.rb
+has_rdoc: true
+homepage: http://github.com/niquola/famili
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails plugin for postgres
+test_files: []
+