active_conductor 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Scott Taylor
+
+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,91 @@
+# ActiveConductor
+
+This plugin uses the conductor pattern to wrap multiple models as one object.
+It's basically like the Presenter pattern, but for saving and creating multiple models.
+For more information, please read the blog post
+[Presenters & Conductors on Rails](http://blog.new-bamboo.co.uk/2007/8/31/presenters-conductors-on-rails).
+
+## Installation
+
+This plugin is built on top of Rails 3 ActiveModel. For a Rails 2 compatible version, see the
+[Conductor](https://github.com/smtlaissezfaire/conductor) plugin.
+
+### Gem
+
+Install the gem:
+
+    gem install active_conductor
+
+Add it to your Gemfile:
+
+     gem "active_conductor"
+
+### Plugin
+
+Install as a Rails plugin:
+
+    rails plugin install git://github.com/netzpirat/active_conductor.git
+
+## Documentation
+
+You can browse the API documentation directly on [rdoc.info](http://rdoc.info/github/netzpirat/active_conductor/master/frames).
+
+## Example
+
+    class SignupConductor < ActiveConductor
+      def models
+        [user, profile]
+      end
+
+      def user
+        @user ||= User.new
+      end
+
+      def profile
+        @profile ||= Profile.new
+      end
+
+      conduct :user, :first_name, :last_name
+      conduct :profile, :image
+    end
+
+    conductor = SignupConductor.new
+    conductor.first_name = "Scott"
+    conductor.last_name = "Taylor"
+
+    conductor.first_name #=> "Scott"
+    conductor.user.first_name #=> "Scott"
+
+    conductor.save
+    conductor.valid? #=> false
+
+    conductor.errors #=> [["photo", "is not valid"]]
+
+## Contributors
+
+* Michael Kessler ([netzpirat](https://github.com/netzpirat))
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2011 Scott Taylor
+
+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/lib/active_conductor.rb

@@ -0,0 +1,161 @@
+require "active_model"
+require "forwardable"
+
+# The ActiveConductor is an implementation of the conductor pattern.
+#
+# The conductor pattern unifies some models into a single object and
+# cleans up controller code massively.
+#
+# @example
+#   class SignupConductor < ActiveConductor
+#     def models
+#       [user, profile]
+#     end
+#
+#     def user
+#       @user ||= User.new
+#     end
+#
+#     def profile
+#       @profile ||= Profile.new
+#     end
+#
+#     conduct :user, :first_name, :last_name
+#     conduct :profile, :image
+#   end
+#
+# @author Scott Taylor
+# @author Michael Kessler
+#
+class ActiveConductor
+  include ActiveModel::Conversion
+  include ActiveModel::Validations
+
+  extend ActiveModel::Naming
+  extend ActiveModel::Translation
+  extend Forwardable
+
+  # Conduct an attribute from the conductor to the associated
+  # model.
+  #
+  # @example Conduct an the email and password attribute to the user model
+  #   conduct :user, :email, :password
+  #
+  # @param model [Symbol] the name of the model
+  # @param *attributes [Symbol] one or more model attribute name
+  #
+  def self.conduct(model, *attributes)
+    attributes.each do |attr|
+      def_delegator model, attr
+      def_delegator model, "#{attr}="
+    end
+  end
+
+  # Initialize the conductor with optional attributes.
+  #
+  # @param attributes [Hash] the attributes hash
+  # @return [ActiveConductor] the created conductor
+  #
+  def initialize(attributes={})
+    self.attributes = attributes
+  end
+
+  # Set the attributes on the associated models.
+  #
+  # @param attributes [Hash] the attributes hash
+  #
+  def attributes=(attributes)
+    attributes.each do |key, value|
+      self.send("#{key}=", value)
+    end if attributes
+  end
+
+  # Tests if all of the records have been persisted.
+  #
+  # @return [true, false] the persistence status
+  #
+  def new_record?
+    models.all? { |m| m.new_record? }
+  end
+
+  # Tests if the associated models have errors. The errors
+  # can be accessed afterwards through {#errors}.
+  #
+  # @return [true, false] the error status
+  #
+  def valid?
+    models.inject(true) do |result, model|
+      valid = model.valid?
+
+      model.errors.each do |field, value|
+        errors.add(field, value)
+      end
+
+      result && valid
+    end
+  end
+
+  # Returns the errors of the conductor. The errors
+  # are populated after a call to {#save}, {#valid?} or {.create}.
+  #
+  # @return [Hash] the error hash
+  #
+  def errors
+    @errors ||= ActiveModel::Errors.new(self)
+  end
+
+  # The models that the conductor holds.
+  #
+  # @return [Array] the array with the conducted models
+  #
+  def models
+    []
+  end
+
+  # Saves the associated models.
+  #
+  # @return [true, false] the saved status
+  #
+  def save
+    models.each { |model| return false unless model.save } if valid?
+  end
+
+  # Create and persist a new conductor in one step.
+  #
+  # @example Create and yield a conductor
+  #   registration = Registration.create(params[:registration]) do |conductor\
+  #     conductor.user.is_admin = true
+  #   end
+  #
+  # @param attributes [Hash] the attributes hash to initialize the conductor
+  # @param block [Proc] An optional proc that yields to the created conductor
+  # @return [ActiveConductor] the created conductor
+  #
+  def self.create(attributes, &block)
+    object = new(attributes)
+    yield(object) if block_given?
+    object.save
+    object
+  end
+
+  # ActiveModel compatibility method that always
+  # return false since a conductor cannot be
+  # destroyed (See {#persisted?}).
+  #
+  # @return [false] always false
+  #
+  def destroyed?
+    false
+  end
+
+  # ActiveModel compatibility method that always
+  # return false since a conductor will never be
+  # persisted.
+  #
+  # @return [false] always false
+  #
+  def persisted?
+    false
+  end
+
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification 
+name: active_conductor
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Scott Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 10
+        version: 1.0.10
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 4
+        version: 0.6.4
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 11
+        version: 2.0.11
+  type: :development
+  version_requirements: *id009
+description: This plugin uses the conductor pattern to wrap multiple models as one object
+email: 
+- scott@railsnewbie.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/active_conductor.rb
+- LICENSE.txt
+- README.md
+has_rdoc: true
+homepage: https://github.com/smtlaissezfaire/active_conductor
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: active_conductor
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Conductor plugin for Rails 3
+test_files: []
+