static-model 1.0

data/.gitignore

@@ -0,0 +1,2 @@
+.yardoc
+doc

data/.yardopts

@@ -0,0 +1 @@
+--protected --charset UTF-8 --markup markdown lib/**/*.rb - LICENSE

data/LICENSE

@@ -0,0 +1,10 @@
+The MIT License
+===============
+
+© 2011 Cody Robbins
+
+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.markdown

@@ -0,0 +1,94 @@
+Static Model
+============
+
+This is a compilation of some boilerplate code for a non–database-backed model based on ActiveModel. You might want to use this kind of static model for anything that needs to be validated but doesn’t persist to the database—such as a login authenticator or an account password reset initiator. It includes the appropriate ActiveModel modules, has a constructor that initializes attributes from a hash, and has some helper methods useful for implementing custom validations.
+
+Full documentation is at [RubyDoc.info](http://rubydoc.info/gems/static-model).
+
+Example
+-------
+
+A user lookup class like the one below could be used as the parent class for a login authenticator or an account password reset initiator. It needs to find a user via their email, which entails validating the presence of the email attribute and providing access to the user that’s consequently looked up.
+
+    class UserLookup < StaticModel
+      # An accessor to allow specifying the email to look up.
+      attr_accessor(:email)
+
+      # A reader to allow access to the user that's looked up.
+      attr_reader(:user)
+
+      # Require the email attribute.
+      validates(:email,
+                :presence => {:message => 'Email is required.'})
+
+      # If the email is present, ensure that a user is associated with it.
+      validate do
+        no_other_errors? && user_exists?
+      end
+
+      # Find the user.
+      def user
+        User.find_by_email(@email)
+      end
+
+      # Add an error if no user is found.
+      def user_exists?
+        user ? true : add_email_error_and_return_false
+      end
+
+      protected
+
+      # Add an error.
+      def add_email_error_and_return_false
+        add_error_and_return_false('Email not found', :email)
+      end
+    end
+
+To use this class in a Rails controller, you’d do something like
+
+    class UserLookupController < ApplicationController
+      def find
+        create_user_lookup
+        do_something if email_valid?
+      end
+
+      protected
+
+      def create_user_lookup
+        @user_lookup = UserLookup.new(params[:user_lookup])
+      end
+
+      def do_something
+        @user_lookup.user.do_something
+      end
+
+      def email_valid?
+        request.post? && @user_lookup.valid?
+      end
+    end
+
+Colophon
+--------
+
+### See also
+
+If you like this gem, you may also want to check out [Declarative Find](http://codyrobbins.com/software/declarative-find), [Create New](http://codyrobbins.com/software/create-new), [Save Changes To](http://codyrobbins.com/software/save-changes-to), and [HTTP Error](http://codyrobbins.com/software/http-error).
+
+### Tested with
+
+* ActiveModel 3.0.5 — 20 May 2011
+
+### Contributing
+
+* [Source](https://github.com/codyrobbins/static-model)
+* [Bug reports](https://github.com/codyrobbins/static-model/issues)
+
+To send patches, please fork on GitHub and submit a pull request.
+
+### Credits
+
+© 2011 [Cody Robbins](http://codyrobbins.com/). See LICENSE for details.
+
+* [Homepage](http://codyrobbins.com/software/static-model)
+* [My other gems](http://codyrobbins.com/software#gems)
+* [Follow me on Twitter](http://twitter.com/codyrobbins)

data/lib/static-model.rb

@@ -0,0 +1,115 @@
+# encoding: UTF-8
+
+# A compilation of some boilerplate code for a non–database-backed model based on ActiveModel. You might want to use this kind of static model for anything that needs to be validated but doesn’t persist to the database—such as a login authenticator or an account password reset initiator. It includes the appropriate ActiveModel modules, has a constructor that initializes attributes from a hash, and has some helper methods useful for implementing custom validations.
+#
+# Example
+# -------
+#
+# A user lookup class like the one below could be used as the parent class for a login authenticator or an account password reset initiator. It needs to find a user via their email, which entails validating the presence of the email attribute and providing access to the user that’s consequently looked up.
+#
+#     class UserLookup < StaticModel
+#       # An accessor to allow specifying the email to look up.
+#       attr_accessor(:email)
+#
+#       # A reader to allow access to the user that's looked up.
+#       attr_reader(:user)
+#
+#       # Require the email attribute.
+#       validates(:email,
+#                 :presence => {:message => 'Email is required.'})
+#
+#       # If the email is present, ensure that a user is associated with it.
+#       validate do
+#         no_other_errors? && user_exists?
+#       end
+#
+#       # Find the user.
+#       def user
+#         User.find_by_email(@email)
+#       end
+#
+#       # Add an error if no user is found.
+#       def user_exists?
+#         user ? true : add_email_error_and_return_false
+#       end
+#
+#       protected
+#
+#       # Add an error.
+#       def add_email_error_and_return_false
+#         add_error_and_return_false('Email not found', :email)
+#       end
+#     end
+#
+# To use this class in a Rails controller, you’d do something like
+#
+#     class UserLookupController < ApplicationController
+#       def find
+#         create_user_lookup
+#         do_something if email_valid?
+#       end
+#
+#       protected
+#
+#       def create_user_lookup
+#         @user_lookup = UserLookup.new(params[:user_lookup])
+#       end
+#
+#       def do_something
+#         @user_lookup.user.do_something
+#       end
+#
+#       def email_valid?
+#         request.post? && @user_lookup.valid?
+#       end
+#     end
+class StaticModel
+  # Includes.
+  include(ActiveModel::Naming)
+  include(ActiveModel::Conversion)
+  include(ActiveModel::Validations)
+
+  # Methods.
+
+  # Creates an instance of the model with its attributes initialized from a hash, just like you can do with ActiveRecord models.
+  #
+  # @param attributes [Hash] The attributes of the model and the respective values to initialize them with.
+  #
+  # @example
+  #    class User < StaticModel
+  #      attr_accessor(:name, :email)
+  #    end
+  #
+  #    user = User.new(:name => 'Dagny Taggart', :email => 'dagny@taggart.com')
+  #
+  #    user.name  #=> Dagny Taggart
+  #    user.email #=> dagny@taggart.com
+  def initialize(attributes = {})
+    attributes ||= {}
+    attributes.each do |name, value|
+      send("#{name}=", value)
+    end
+  end
+
+  # This method simply tells ActiveModel that this model is not database-backed.
+  def persisted?
+    false
+  end
+
+  protected
+
+  # A helper method to be used internally by subclasses which simply indicates whether there are currently any errors. This is useful for validation methods in subclasses that shouldn’t fire if there are already other errors. For example, the format of an email address might only need to be checked if the email address is present.
+  def no_other_errors?
+    errors.empty?
+  end
+
+  # A helper method to be used internally by subclasses which adds an error to the `:base` attribute and returns `false` so that it can halt validations chains.
+  #
+  # @param error [String] The error message.
+  # @param attribute [Symbol] The attribute of the model to place the error message on.
+  # @return [boolean] Returns `false` in order to halt any validation chain it may be invoked from.
+  def add_error_and_return_false(error, attribute = :base)
+    errors[attribute] << error
+    false
+  end
+end

data/static-model.gemspec

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+Gem::Specification.new do |s|
+  s.name     = 'static-model'
+  s.version  = '1.0'
+  s.summary  = 'A base non–database-backed model for Rails.'
+  s.homepage = 'http://codyrobbins.com/software/static-model'
+  s.author   = 'Cody Robbins'
+  s.email    = 'cody@codyrobbins.com'
+
+  s.post_install_message = '
+-------------------------------------------------------------
+Follow me on Twitter! http://twitter.com/codyrobbins
+-------------------------------------------------------------
+
+'
+
+  s.files = `git ls-files`.split
+
+  s.add_dependency('activemodel')
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: static-model
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "1.0"
+platform: ruby
+authors: 
+- Cody Robbins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-31 00:00:00 -04: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 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: cody@codyrobbins.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .yardopts
+- LICENSE
+- README.markdown
+- lib/static-model.rb
+- static-model.gemspec
+has_rdoc: true
+homepage: http://codyrobbins.com/software/static-model
+licenses: []
+
+post_install_message: "\n\
+  -------------------------------------------------------------\n\
+  Follow me on Twitter! http://twitter.com/codyrobbins\n\
+  -------------------------------------------------------------\n\n"
+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: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: "A base non\xE2\x80\x93database-backed model for Rails."
+test_files: []
+