not_only_but_also 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Adam Meehan
+
+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,63 @@
+= Not Only... But Also
+
+The Rails 'fat model' pattern is a good one but can result in very large model classes. It can be
+unwieldy to work in such files as they begin to look a bit messy. Assuming you have judiciously 
+appraised the model for opportunities to extract out pieces into libraries, it still may leave you with
+a lot of code. I find this is particularly the case for validations for models with a large number of columns.
+
+This is where allowing for multiple files to define a class can help and is what NotOnlyButAlso does. It defines a
+convention to help organise multiple files as well as avoiding the need for repititive code when using modules as
+containers or re-opening the classes.
+ 
+You might recognise this style of solution as used by the concerned_with plugin (http://github.com/jakehow/concerned_with/).
+I wrote this a long time ago before I knew of the concerned_with plugin. I have released it because its got a simpler interface
+and I love the name.
+
+For interest here are some discussions of this type of solution in regards to concerned_with: 
+
+http://m.onkey.org/2008/9/15/active-record-tips-and-tricks
+
+http://paulbarry.com/articles/2008/08/30/concerned-with-skinny-controller-skinny-model
+
+For extra credit:
+
+http://en.wikipedia.org/wiki/Not_Only..._But_Also
+
+== Install
+
+From Gemcutter:
+
+  gem install not_only_but_also
+
+Or as plugin:
+
+  ./script/install plugin git://github.com/adzap/not_only_but_also.git
+
+== Usage
+
+For example you want to extract out the validations to a separate file:
+
+  class Post
+    not_only_but_also :validations
+  end
+
+  # in app/models/post/validations.rb
+
+  Post.not_only_but_also do
+    validates_presence_of :title
+  end
+
+OR the shorthand version:
+
+  class Post
+    also_has :validations
+  end
+
+  # in app/models/post/validations.rb
+
+  Post.also_has do
+    validates_presence_of :title
+  end
+
+
+Copyright (c) 2009 Adam Meehan, released under the MIT license

data/Rakefile

@@ -0,0 +1,73 @@
+require 'rubygems'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'spec/rake/spectask'
+
+GEM_NAME = "not_only_but_also"
+GEM_VERSION = '0.1.0'
+AUTHOR   = "Adam Meehan"
+EMAIL    = "adam.meehan@gmail.com"
+HOMEPAGE = "http://github.com/adzap/not_only_but_also"
+SUMMARY  = "Rails plugin to split large models into separate files of concern. Like concerned_with but a little more convenient."
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.rubyforge_project = "not_only_but_also"
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  s.require_path = 'lib'
+  s.autorequire = GEM_NAME
+  s.files = %w(MIT-LICENSE README.rdoc Rakefile) + Dir.glob("{lib,spec}/**/*")
+end
+
+desc 'Default: run specs.'
+task :default => :spec
+
+spec_files = Rake::FileList["spec/**/*_spec.rb"]
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts = ["-c"]
+end
+
+desc "Generate code coverage"
+Spec::Rake::SpecTask.new(:coverage) do |t|
+  t.spec_files = spec_files
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec,/var/lib/gems']
+end
+
+desc 'Generate documentation for plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NotOnlyButAlso'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM_NAME}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/lib/not_only_but_also.rb

@@ -0,0 +1,34 @@
+module NotOnlyButAlso
+
+  module ClassMethods
+
+    def not_only_but_also(*contexts, &block)
+      if block_given?
+        self.class_eval(&block)
+      else
+        contexts.each do |context|
+          NotOnlyButAlso::Helpers.require_context_file(name, context)
+        end
+      end
+    end
+    alias also_has not_only_but_also
+
+  end
+
+  module Helpers
+
+    class << self
+
+      def require_context_file(class_name, context)
+        require_dependency "#{class_name.underscore}/#{context}" 
+      rescue MissingSourceFile => e
+        raise e, "NotOnlyButAlso could not find a file for #{class_name} using context #{context}"
+      end
+
+    end
+
+  end
+
+end
+
+ActiveRecord::Base.extend NotOnlyButAlso::ClassMethods

data/spec/not_only_but_also_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe NotOnlyButAlso do
+
+  before do
+    Object.send(:remove_const, :Post)    if Object.const_defined?(:Post)
+    Object.send(:remove_const, :Comment) if Object.const_defined?(:Comment)
+    ActiveSupport::Dependencies.loaded = []
+  end
+
+  it 'should include only named context' do
+    Post.class_eval do
+      also_has :validations
+    end
+    Post.should respond_to(:test_validation_method)
+    Post.should_not respond_to(:test_stuff_method)
+  end
+
+  it 'should include all named contexts' do
+    Post.class_eval do
+      also_has :validations, :stuff
+    end
+    Post.should respond_to(:test_validation_method)
+    Post.should respond_to(:test_stuff_method)
+  end
+
+end

data/spec/rails_root/app/models/post/stuff.rb

@@ -0,0 +1,4 @@
+Post.also_has do
+  def self.test_stuff_method
+  end
+end

data/spec/rails_root/app/models/post/validations.rb

@@ -0,0 +1,4 @@
+Post.also_has do
+  def self.test_validation_method
+  end
+end

data/spec/rails_root/app/models/post.rb

@@ -0,0 +1,2 @@
+class Post < ActiveRecord::Base
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'spec'))
+
+require 'rubygems'
+require 'spec/autorun'
+
+require 'active_record'
+require 'active_support'
+require 'not_only_but_also'
+
+RAILS_ROOT = File.join(File.dirname(__FILE__), 'rails_root')
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.establish_connection({:adapter => 'sqlite3', :database => ':memory:'})
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :posts, :force => true do |t|    
+    t.string :title
+  end
+end
+
+ActiveSupport::Dependencies.load_paths = %W( #{RAILS_ROOT}/app #{RAILS_ROOT}/app/models )

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: not_only_but_also
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Adam Meehan
+autorequire: not_only_but_also
+bindir: bin
+cert_chain: []
+
+date: 2009-11-06 00:00:00 +11:00
+default_executable: 
+dependencies: []
+
+description: Rails plugin to split large models into separate files of concern. Like concerned_with but a little more convenient.
+email: adam.meehan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/not_only_but_also.rb
+- spec/not_only_but_also_spec.rb
+- spec/spec_helper.rb
+- spec/rails_root/app/models/post/stuff.rb
+- spec/rails_root/app/models/post/validations.rb
+- spec/rails_root/app/models/post.rb
+has_rdoc: true
+homepage: http://github.com/adzap/not_only_but_also
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: not_only_but_also
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Rails plugin to split large models into separate files of concern. Like concerned_with but a little more convenient.
+test_files: []
+