has_crud_for 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in has_crud_for.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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,70 @@
+= HasCrudFor
+
+Follow Law of Demeter in ActiveRecord models.
+
+HasCrudFor is a small meta-programming snippet that adds find_*, build_*, create_*, update_* and destroy_* methods intended as a better API for your associations.
+
+== Example
+
+  class Blog < ActiveRecord::Base
+    has_many :posts
+
+    extend HasCrudFor
+    has_crud_for :posts
+    has_crud_for :comments, :through => :posts
+  end
+
+  class Post
+    has_many :comments
+  end
+
+  blog.create_post(post_attributes)
+  blog.build_post(post_attributes)
+  blog.create_comment(post_id, comment_attributes)
+  blog.create_comment!(post_id, comment_attributes)  # will raise exception upon failed validation
+
+== Benefits
+
+* easily delegate methods to other objects:
+
+    class User
+      belongs_to :blog
+      delegate :create_post, :to => :blog
+    end
+
+* replace methods with own implementation
+
+    class Blog
+      has_crud_for :posts
+
+      def create_post(attributes)
+        posts.create(attributes).tap { |post| post.publish! }
+      end
+    end
+
+  You can do whatever you need when creating new post, without hunting for blog.posts.create through your codebase! And without resorting to ActiveRecord callbacks.
+
+* less coupling - objects don't have to know about internal structure of other objects
+
+* easier to mock in tests
+
+== Options
+
+* :only, :except - specify which methods should be generated; please note that :create generates two methods: create_* and create_*!
+    has_crud_for :posts, :only => [:find, :create]
+    has_crud_for :posts, :except => [:destroy]
+* :as - use different prefix in method names
+    has_crud_for :posts, :as => :entries # generates methods create_entry, build_entry, etc.
+* :through - create methods for nested associations
+    has_crud_for :comments, :through => :posts
+    has_crud_for :comments, :through => :posts, :as => :posts_comments
+
+== FAQ
+
+* Do I need to use ActiveRecord? Or Rails?
+
+  No. But HasCrudFor depends on inflections from ActiveSupport. And that pulls i18n gem as well.
+
+== License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new("spec") do |t|
+  t.pattern = "spec/{*_spec.rb}"
+end

data/has_crud_for.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "has_crud_for/version"
+
+Gem::Specification.new do |s|
+  s.name        = "has_crud_for"
+  s.version     = HasCrudFor::VERSION
+  s.authors     = ["Jan Dudek"]
+  s.email       = ["jd@jandudek.com"]
+  s.homepage    = ""
+  s.summary     = %q{Law of Demeter in ActiveRecord models}
+  s.description = %q{HasCrudFor is a small meta-programming snippet that adds find_*, build_*, create_*, update_* and destroy_* methods intended as a better API for your associations}
+
+  s.rubyforge_project = "has_crud_for"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+
+  s.add_runtime_dependency "activesupport"
+  s.add_runtime_dependency "i18n"
+end

data/lib/has_crud_for/version.rb

@@ -0,0 +1,3 @@
+module HasCrudFor
+  VERSION = "0.0.1"
+end

data/lib/has_crud_for.rb

@@ -0,0 +1,83 @@
+require "has_crud_for/version"
+require "active_support/core_ext/string/inflections"
+require 'active_support/core_ext/module/introspection'
+
+module HasCrudFor
+  DEFAULT_METHODS = [:find, :build, :create, :update, :destroy]
+
+  def has_crud_for(models, options = {})
+    methods = begin
+      if only = options[:only]
+        only
+      elsif except = options[:except]
+        DEFAULT_METHODS - except
+      else
+        DEFAULT_METHODS
+      end
+    end
+
+    name = (options[:as] || models).to_s.singularize
+    if through = options[:through]
+      parent = through.to_s.singularize
+      define_crud_through_methods(models, name, parent, methods)
+    else
+      define_crud_methods(models, name, methods)
+    end
+  end
+
+  private
+
+  def define_crud_methods(models, name, methods = [])
+    define_method "find_#{name}".to_sym do |id|
+      send(models).find(id)
+    end if methods.include?(:find)
+
+    define_method "build_#{name}".to_sym do |hash = {}|
+      send(models).build(hash)
+    end if methods.include?(:build)
+
+    define_method "create_#{name}".to_sym do |hash = {}|
+      send(models).create(hash)
+    end if methods.include?(:create)
+
+    define_method "create_#{name}!".to_sym do |hash = {}|
+      send(models).create!(hash)
+    end if methods.include?(:create)
+
+    define_method "update_#{name}".to_sym do |id, hash|
+      send(models).update(id, hash)
+    end if methods.include?(:update)
+
+    define_method "destroy_#{name}".to_sym do |id|
+      send(models).destroy(id)
+    end if methods.include?(:destroy)
+  end
+
+  def define_crud_through_methods(models, name, parent, methods = [])
+    model_name = models.to_s.singularize
+
+    define_method "find_#{name}".to_sym do |parent_id, id|
+      send("find_#{parent}", parent_id).send("find_#{model_name}", id)
+    end if methods.include?(:find)
+
+    define_method "build_#{name}".to_sym do |parent_id, hash = {}|
+      send("find_#{parent}", parent_id).send("build_#{model_name}", hash)
+    end if methods.include?(:build)
+
+    define_method "create_#{name}".to_sym do |parent_id, hash = {}|
+      send("find_#{parent}", parent_id).send("create_#{model_name}", hash)
+    end if methods.include?(:create)
+
+    define_method "create_#{name}!".to_sym do |parent_id, hash = {}|
+      send("find_#{parent}", parent_id).send("create_#{model_name}!", hash)
+    end if methods.include?(:create)
+
+    define_method "update_#{name}".to_sym do |parent_id, id, hash|
+      send("find_#{parent}", parent_id).send("update_#{model_name}", id, hash)
+    end if methods.include?(:update)
+
+    define_method "destroy_#{name}".to_sym do |parent_id, id|
+      send("find_#{parent}", parent_id).send("destroy_#{model_name}", id)
+    end if methods.include?(:destroy)
+  end
+end

data/spec/has_crud_for_spec.rb

@@ -0,0 +1,138 @@
+require File.dirname(__FILE__) + "/../lib/has_crud_for"
+
+describe HasCrudFor do
+  describe "without :through" do
+    before do
+      klass = Class.new do
+        extend HasCrudFor
+        has_crud_for :items
+      end
+      @subject = klass.new
+      @items = mock
+      @subject.stub!(:items).and_return(@items)
+      @id = 1
+      @attributes = {}
+    end
+
+    it "should have find_item" do
+      @items.should_receive(:find).with(@id)
+      @subject.find_item(@id)
+    end
+
+    it "should have build_item" do
+      @items.should_receive(:build).with(@attributes)
+      @subject.build_item(@attributes)
+    end
+
+    it "should have create_item" do
+      @items.should_receive(:create).with(@attributes)
+      @subject.create_item(@attributes)
+    end
+
+    it "should have create_item!" do
+      @items.should_receive(:create!).with(@attributes)
+      @subject.create_item!(@attributes)
+    end
+
+    it "should have update_item" do
+      @items.should_receive(:update).with(@id, @attributes)
+      @subject.update_item(@id, @attributes)
+    end
+
+    it "should have destroy_item" do
+      @items.should_receive(:destroy).with(@id)
+      @subject.destroy_item(@id)
+    end
+  end
+
+  describe "with :through" do
+    before do
+      klass = Class.new do
+        extend HasCrudFor
+        has_crud_for :children, :through => :parents
+      end
+      @subject = klass.new
+      @parent_id = 1
+      @child_id = 2
+      @attributes = {}
+      @parent = mock
+      @children = mock
+      @subject.stub!(:find_parent).with(@parent_id).and_return(@parent)
+    end
+
+    it "should have find_child" do
+      @parent.should_receive(:find_child).with(@child_id)
+      @subject.find_child(@parent_id, @child_id)
+    end
+
+    it "should have build_child" do
+      @parent.should_receive(:build_child).with(@attributes)
+      @subject.build_child(@parent_id, @attributes)
+    end
+
+    it "should have create_child" do
+      @parent.should_receive(:create_child).with(@attributes)
+      @subject.create_child(@parent_id, @attributes)
+    end
+
+    it "should have create_child!" do
+      @parent.should_receive(:create_child!).with(@attributes)
+      @subject.create_child!(@parent_id, @attributes)
+    end
+
+    it "should have update_child" do
+      @parent.should_receive(:update_child).with(@child_id, @attributes)
+      @subject.update_child(@parent_id, @child_id, @attributes)
+    end
+
+    it "should have destroy_child" do
+      @parent.should_receive(:destroy_child).with(@child_id)
+      @subject.destroy_child(@parent_id, @child_id)
+    end
+  end
+
+  describe "with :except" do
+    klass = Class.new do
+      extend HasCrudFor
+      has_crud_for :items, :except => [:update, :destroy]
+    end
+
+    subject { klass.new }
+
+    it { should respond_to :find_item }
+    it { should respond_to :build_item }
+    it { should respond_to :create_item }
+    it { should_not respond_to :update_item }
+    it { should_not respond_to :destroy_item }
+  end
+
+  describe "with :only" do
+    klass = Class.new do
+      extend HasCrudFor
+      has_crud_for :items, :only => [:find, :build, :create]
+    end
+
+    subject { klass.new }
+
+    it { should respond_to :find_item }
+    it { should respond_to :build_item }
+    it { should respond_to :create_item }
+    it { should_not respond_to :update_item }
+    it { should_not respond_to :destroy_item }
+  end
+
+  describe "with :as" do
+    klass = Class.new do
+      extend HasCrudFor
+      has_crud_for :items, :as => :things
+    end
+
+    subject { klass.new }
+
+    it { should respond_to :find_thing }
+    it { should respond_to :build_thing }
+    it { should respond_to :create_thing }
+    it { should respond_to :update_thing }
+    it { should respond_to :destroy_thing }
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: has_crud_for
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jan Dudek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70287765609300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70287765609300
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70287765608820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70287765608820
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70287765608320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70287765608320
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70287765607760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70287765607760
+description: HasCrudFor is a small meta-programming snippet that adds find_*, build_*,
+  create_*, update_* and destroy_* methods intended as a better API for your associations
+email:
+- jd@jandudek.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- has_crud_for.gemspec
+- lib/has_crud_for.rb
+- lib/has_crud_for/version.rb
+- spec/has_crud_for_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: has_crud_for
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: Law of Demeter in ActiveRecord models
+test_files:
+- spec/has_crud_for_spec.rb