activerecord-concernable 0.4.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-concernable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Blake Taylor
+
+MIT License
+
+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.md

@@ -0,0 +1,83 @@
+# Activerecord::Concernable
+
+A DSL for defining ActiveRecord concerns.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-concernable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-concernable
+
+## Usage
+
+The Concernable DSL is available within any ActiveRecord::Base. The DSL consist
+of a single command `concern`. Use it to define concerns for the object. The
+body of the concern follows the same rules that of [ActiveSupport::Concern][1].
+
+Defining concerns:
+
+    class Notification < ActiveRecord::Base
+
+      belongs_to :user
+      belongs_to :notifiable, polymorphic: true
+
+      # Extend user with has_many :notifications. When concern is passed a class
+      # the generated concern will automatically be mixed into that class.
+      concern User do
+        included do
+          has_many :notifications
+        end
+      end
+
+      # Create a named concern by passing a symbol. Mix into any number of
+      # classes by passing them as `:of` in the options hash.
+      concern :notifiable, of: [Comments, Posts] do
+        included do
+          has_many :notifications, as: :subject, dependent: :destroy
+        end
+
+        def create_notification(message)
+          notifications.create(message: message)
+        end
+      end
+    end
+
+### Why would I want to do this?
+
+The primary reason for using the DSL is to keep ActiveRecord models skinny and
+well defined, and to avoid the inevitability of monolithic model object (1000
+line user.rb anyone?).
+
+The idea is that as new models are introduced, they will often be related, and
+therefore "concerned" with other models in the system. To a large extent, this
+is the very point of relational data and ActiveRecord. Unfortunately, This
+creates pain points at the cruxes of the domain model. New objects are concerned
+with the popular objects, and the popular objects accumulate the inverse
+concerns and functionality.
+
+Concern modules can solve this problem is by allowing you to avoid adding
+additional code to the centralized definition of the core class when adding a
+new associated class. Instead, you simply add a concern and mix it in.
+
+This is essentially what the DSL does, but takes things a few steps further, by
+allowing you to easily nest the concern definition right inside the dependent
+model and then mix into the dependant classes unobtrusively.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+[1]: http://api.rubyonrails.org/classes/ActiveSupport/Concern.html

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/activerecord-concernable.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord-concernable/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "activerecord-concernable"
+  gem.version       = Activerecord::Concernable::VERSION
+  gem.authors       = ["Blake Taylor"]
+  gem.email         = ["blakefrost@gmail.com"]
+  gem.description   = %q{A DSL for defining ActiveRecord concerns}
+  gem.summary       = %q{
+    Helps keep models skinny and code understandable by making it simple to
+    define concerns and mix them into the affect class right from within the
+    concerned class. See readme for more information.
+  }
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('activerecord')
+  gem.add_development_dependency('rake')
+end

data/lib/activerecord-concernable.rb

@@ -0,0 +1,67 @@
+require "activerecord-concernable/version"
+
+module ActiveRecord
+  module Concernable
+    # Defines a concern.
+    #
+    # Concern will be named by convention below the ::Concerns module. Concern
+    # will be wrapped in namespace named by convention from the class defining the
+    # concern. For example, a User concern within the Notification class would
+    # be available at ::Concerns::Notification::User
+    #
+    # By convention, if a class is passed as the concern name, the concern will be
+    # automatically mixed into the passed class. If this functionality is not
+    # desirable, pass the name as a symbol i.e. :user.
+    #
+    # To mix into additional classes, pass them classes as an array to the of
+    # option key.
+    #
+    # Example:
+    #
+    #   class Notification
+    #     extend Concernable
+    #
+    #     concern :user do
+    #       included do
+    #         has_many :notifications
+    #       end
+    #     end
+    #
+    #     concern :notifiable, of: [Comments, Posts] do
+    #       include do
+    #         has_many :notifications, as: :subject, dependent: :destroy
+    #       end
+    #
+    #       def create_notifcation(*args)
+    #         notications.create(*args)
+    #       end
+    #     end
+    #   end
+    #
+    def concern(name, opts={}, &block)
+      namespace = self.to_s.split('::').reduce(::Concerns) do |namespace, module_name|
+        namespace.const_defined?(module_name, false) ? namespace.const_get(module_name) : namespace.const_set(module_name, Module.new)
+      end
+
+      # Create and populate concern module.
+      camelized_name = name.to_s.camelize
+      concern = Module.new
+      concern.send(:extend, ActiveSupport::Concern)
+      concern.class_eval(&block)
+      concern = namespace.const_set(camelized_name, concern)
+
+      # Mix-in concern
+      opts.symbolize_keys!
+      opts[:of] = Array(opts[:of])
+      opts[:of] << name if name.instance_of? Class
+      Array(opts[:of]).each { |klass| klass.send(:include, concern) }
+    end
+
+  end
+end
+
+# Defines namespace for where concerns will be defined to.
+module Concerns; end
+
+# Extend Active Record Base with Concernable.
+ActiveRecord::Base.extend ActiveRecord::Concernable

data/lib/activerecord-concernable/version.rb

@@ -0,0 +1,5 @@
+module Activerecord
+  module Concernable
+    VERSION = "0.4.0"
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-concernable
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- Blake Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A DSL for defining ActiveRecord concerns
+email:
+- blakefrost@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-concernable.gemspec
+- lib/activerecord-concernable.rb
+- lib/activerecord-concernable/version.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'
+      segments:
+      - 0
+      hash: 1236418441682571541
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1236418441682571541
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Helps keep models skinny and code understandable by making it simple to define
+  concerns and mix them into the affect class right from within the concerned class.
+  See readme for more information.
+test_files: []