informal 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 informal.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 by Josh Susser
+
+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,65 @@
+# Informal
+
+Informal is a small gem that enhances a Plain Old Ruby Object so it can be used
+with Rails 3 form helpers in place of an ActiveRecord model. It works with the
+Rails `form_for` helper, and `simple_form` as well.
+
+Here's a quick (and slightly insane) example:
+
+    # models/command.rb
+    require "informal"
+    class Command
+      include Informal::Model
+      attr_accessor :command, :args
+      validates_presence_of :command
+      def run; `#{command} #{args}`; end
+    end
+    
+    # views/commands/new.html.erb
+    <%= form_for @command do |form| %>
+      <%= form.text_field :command %>
+      <%= form.text_field :args %>
+      <%= form.submit "Do It!" %>
+    <% end %>
+    
+    # controllers/commands_controller.rb
+    def create
+      command = Command.new(params[:command])
+      if command.valid?
+        command.run
+      end
+    end
+
+## Installation
+
+It's a Ruby gem, so just install it with `gem install informal`, add it to your
+bundler Gemfile, or do whatever you like to do with gems. There is nothing to
+configure.
+
+## Usage
+
+The insanity of the above example aside, Informal is pretty useful for creating
+simple RESTful resources that don't map directly to ActiveRecord models. It
+evolved from handling login credentials to creating model objects that were
+stored in a serialized attribute of a parent resource.
+
+In many ways using an informal model is just like using an AR model in
+controllers and views. The biggest difference is that you don't `save` an
+informal object, but you can add validations and check if it's `valid?`. If
+there are any validation errors, the object will have all the usual error
+decorations so that error messages will display properly in the form view.
+
+### Initialization, #super and attributes
+
+If you include `Informal::Model`, your class automatically gets an
+`#initialize` method that takes a params hash and calls setters for all
+attributes in the hash. If your model class inherits from a class that has its
+own `#initialize` method that needs to get the super call, you should instead
+include `Informal::ModelNoInit`, which does not create an `#initialize` method.
+Make your own `#initialize` method, and in that you can assign the attributes
+using the `#attributes=` method and also call super with whatever args are
+needed.
+
+## License
+
+Released under the MIT License.  See the LICENSE file.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new("test_all") do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = false
+end
+
+desc "Run all tests"
+task :default => :test_all

data/informal.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "informal/version"
+
+Gem::Specification.new do |s|
+  s.name        = "informal"
+  s.version     = Informal::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Josh Susser"]
+  s.email       = ["josh@hasmanythrough.com"]
+  s.homepage    = ""
+  s.summary     = %q{Easily use any Plain Old Ruby Object as the model for Rails form helpers.}
+  s.description = %q{Easily use any Plain Old Ruby Object as the model for Rails form helpers.}
+
+  s.rubyforge_project = "informal"
+
+  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_dependency('activemodel', "~> 3.0")
+end

data/lib/informal.rb

@@ -0,0 +1 @@
+require "informal/model"

data/lib/informal/model.rb

@@ -0,0 +1,15 @@
+require "informal/model_no_init"
+
+module Informal
+  module Model
+    def self.included(klass)
+      klass.class_eval do
+        include ModelNoInit
+      end
+    end
+
+    def initialize(attrs={})
+      self.attributes = attrs
+    end
+  end
+end

data/lib/informal/model_no_init.rb

@@ -0,0 +1,23 @@
+require "active_model"
+module Informal
+  module ModelNoInit
+    def self.included(klass)
+      klass.class_eval do
+        extend  ActiveModel::Naming
+        include ActiveModel::Validations
+      end
+    end
+
+    def attributes=(attrs)
+      attrs.each_pair { |name, value| self.send("#{name}=", value) }
+    end
+
+    def new_record?
+      true
+    end
+
+    def to_key
+      [object_id]
+    end
+  end
+end

data/lib/informal/version.rb

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

data/test/model_no_init_test.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
+
+class ModelNoInitTest < Test::Unit::TestCase
+  class KalEl
+    attr_accessor :k
+    def initialize(uber)
+      @k = uber
+    end
+  end
+  class Poro < KalEl
+    include Informal::ModelNoInit
+    attr_accessor :x, :y, :z
+    validates_presence_of :x, :y, :z
+    def initialize(attrs={})
+      super(true)
+      self.attributes = attrs
+    end
+  end
+  def poro_class; Poro; end
+
+  include ModelTestCases
+
+  def test_super
+    assert @model.k
+  end
+end

data/test/model_test.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
+
+class ModelTest < Test::Unit::TestCase
+  class Poro
+    include Informal::Model
+    attr_accessor :x, :y, :z
+    validates_presence_of :x, :y, :z
+  end
+  def poro_class; Poro; end
+
+  include ModelTestCases
+end

data/test/model_test_cases.rb

@@ -0,0 +1,29 @@
+module ModelTestCases
+  def setup
+    @model = self.poro_class.new(:x => 1, :y => 2)
+  end
+
+  def test_new
+    assert_equal 1, @model.x
+    assert_equal 2, @model.y
+    assert_nil @model.z
+  end
+
+  def test_new_record
+    assert @model.new_record?
+  end
+
+  def test_to_key
+    assert_equal [@model.object_id], @model.to_key
+  end
+
+  def test_naming
+    assert_equal "Poro", @model.class.model_name.human
+  end
+
+  def test_validations
+    assert @model.invalid?
+    assert_equal [], @model.errors[:x]
+    assert @model.errors[:z].any? {|err| err =~ /blank/}
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require "test/unit"
+
+require "rubygems"
+require "bundler/setup"
+
+require "informal/model"
+require "informal/model_no_init"
+
+require File.expand_path(File.join(File.dirname(__FILE__), "model_test_cases"))

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: informal
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Josh Susser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-24 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 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+description: Easily use any Plain Old Ruby Object as the model for Rails form helpers.
+email: 
+- josh@hasmanythrough.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- informal.gemspec
+- lib/informal.rb
+- lib/informal/model.rb
+- lib/informal/model_no_init.rb
+- lib/informal/version.rb
+- test/model_no_init_test.rb
+- test/model_test.rb
+- test/model_test_cases.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: informal
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Easily use any Plain Old Ruby Object as the model for Rails form helpers.
+test_files: 
+- test/model_no_init_test.rb
+- test/model_test.rb
+- test/model_test_cases.rb
+- test/test_helper.rb