representations 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2009 Łukasz Piestrzeniewicz, Adam Sokolnicki
+
+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,44 @@
+# Resouce Representations
+
+Rails helpers, including form builders are great to allow rapid development of applications and views.
+
+They are procedural in nature and have hard time to adapt to complex models. They also live in a single namespace making it difficult to find which helpers apply to which models.
+
+Resource representations change syntax to object oriented and model specific.
+
+## Example usage
+
+Rails helpers:
+
+    - form_for(user) do |f|
+      login:
+      = h(user.login)
+      = f.label(:email, "Email")
+      = f.text_field(:email)
+      - if user.profile
+        - fields_for(user.profile) do |p|
+            Full name:
+            = h(full_name(p))
+            = f.label(:first_name, "First name")
+            = f.text_field(:first_name)
+            = f.label(:last_name, "Last name")
+            = f.text_field(:last_name)
+            = f.radio_button(:eye_color, 'blue')
+            = f.label(:eye_color_blue, "Blue")
+      = f.submit("Submit")
+
+Resource Representations
+
+    - r(user).form do
+      login:
+      = user.login
+      = user.email.label
+      = user.email.text_field
+      - user.profile do |p|
+        = full_name(p)
+        = p.first_name.label
+        = p.first_name.text_field
+        = p.last_name.label
+        = p.last_name.text_field
+        = p.eye_color.radio_button('blue')
+        = p.eye_color.radio_button_label('blue', 'Blue')

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "representations"
+    gemspec.summary = "Changes syntax of rails helpers and form builders to object oriented and model specific"
+    gemspec.description = "Rails helpers, including form builders are great to allow rapid development of applications and views.  
+They are procedural in nature and have hard time to adapt to complex models. They also live in a single namespace making it difficult to find which helpers apply to which models.  
+Resource representations change syntax to object oriented and model specific."
+    gemspec.email = "skimos00@gmail.com"
+    gemspec.homepage = "http://github.com/bragi/representations"
+    gemspec.authors = ["Łukasz Piestrzeniewicz", "Adam Sokolnicki"]
+    gemspec.files = [
+    ".document",
+     "LICENSE.txt",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/representations.rb",
+     "lib/view_helpers.rb",
+     "rails/init.rb",
+     "representations.gemspec"
+  ]
+    gemspec.test_files.exclude('spec/**/*')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "representations #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/init.rb

@@ -0,0 +1,3 @@
+require 'view_helpers'
+require 'representations'
+ActionView::Base.send :include, Representations::ViewHelpers

data/lib/representations.rb

@@ -0,0 +1,203 @@
+module Representations
+  #Creates Representation for object passed as a paremeter, type of the representation
+  #depends on the type of the object
+  def representation_for(object, template, name=nil, parent=nil)
+    representation_class = if object.is_a?(ActiveRecord::Base)
+      ActiveRecordRepresentation
+    else
+      "Representations::#{object.class.to_s.demodulize}Representation".constantize rescue DefaultRepresentation
+    end
+    representation_class.new(object, template, name, parent)
+  end
+
+  module_function :representation_for
+
+  class Representation 
+
+    #value - object for which the representation is created 
+    #template - template view
+    #name - the actuall name of the method that was called on the parent object of the object that is initialize
+    def initialize(value, template, name=nil, parent=nil)
+      @value = value
+      @name = name
+      @template = template
+      @parent = parent
+    end
+
+    def id
+      @value
+    end
+    #returns escaped string from the object's to_s method
+    def to_s
+      ERB::Util::h(@value.to_s)
+    end
+    #Call the passed block (if any) 
+    def with_block(&block)
+      yield self if block_given?
+    end
+    #returns html label tag for the representation
+    def label(value, html_options = {})
+      tree = get_parents_tree
+      for_attr_value = tree.join('_')
+      tags = get_tags(html_options, {:for => for_attr_value})
+      value = ERB::Util::h(@name.humanize) if value.nil?
+      %Q{<label #{tags}>#{value}</label>}
+    end
+
+    protected
+    #returns array of Represantation objects which are linked together by @parent field
+    def get_parents_tree
+      children_names = Array.new
+      parent = @parent
+      children_names.push(@name)
+      while parent.nil? == false do #iterate parent tree
+        children_names.push(parent.instance_variable_get(:@name))
+        parent = parent.instance_variable_get(:@parent)
+      end #children_names now looks something like that [name, profile, user]
+      children_names.reverse
+    end
+    #creates value of the html name attribute according to passed tree of objects
+    def get_html_name_attribute_value(tree)
+      root_name = tree.delete_at(0)
+      name = Array.new
+      tree.each_index do |idx| 
+        name[idx] =  if idx < tree.length - 1
+             "[" + tree[idx] + "_attributes]"
+                     else
+             "[" + tree[idx] + "]"
+                     end
+      end
+      name.unshift(root_name)
+    end
+    #Returns string of merged two hashes of html options passed as an argument
+    def get_tags(user_options, base_options)
+      base_options.merge!(user_options)
+      base_options.stringify_keys!
+      base_options.map{ |key, value| %(#{key}="#{value}" ) }
+    end
+  end
+
+  class DefaultRepresentation < Representation
+
+    #not tested in the view
+    #Returns string with html check box tag
+    def check_box(checked_value = "1", unchecked_value = "0", html_options = {})
+      tree = get_parents_tree
+      id_attr_value = tree.join('_') 
+      name_attr_value = get_html_name_attribute_value(tree)
+      tags = get_tags(html_options, {:value => checked_value, :id => id_attr_value, :name=>name_attr_value})
+      %Q{<input type="checkbox" #{tags}/>\n<input type="hidden" value="#{unchecked_value}" id="#{id_attr_value}" name="#{name_attr_value}"/>}
+    end
+    #not tested in the view
+    #Returns string with html file field tag
+    def file_field(html_options = {})
+      tree = get_parents_tree
+      id_attr_value = tree.join('_') 
+      tags = get_tags(html_options, {:value => to_s, :id => id_attr_value, :name=>get_html_name_attribute_value(tree)})
+      %Q{<input type="file" #{tags}/>}
+    end
+    #not tested in the view
+    #Returns string with html hidden input tag
+    def hidden_field(html_options = {})
+      tree = get_parents_tree
+      id_attr_value = tree.join('_') 
+      tags = get_tags(html_options, {:value => to_s, :id => id_attr_value, :name=>get_html_name_attribute_value(tree)})
+      %Q{<input type="hidden" #{tags}/>}
+    end
+    #Returns string with html text input tag
+    def text_field(html_options = {})
+      tree = get_parents_tree
+      id_attr_value = tree.join('_') 
+      tags = get_tags(html_options, {:value => to_s, :id => id_attr_value, :name=>get_html_name_attribute_value(tree)})
+      %Q{<input type="text" #{tags}/>}
+    end
+    #Returns string with html text area tag
+    def text_area(html_options = {})
+      tree = get_parents_tree
+      id_attr_value = tree.join('_') 
+      tags = get_tags(html_options, {:id => id_attr_value, :name => get_html_name_attribute_value(tree)})
+      %Q{<textarea #{tags}>\n#{to_s}\n</textarea>}
+    end
+    #Returns string with html password tag
+    def password_field(html_options = {})
+      tree = get_parents_tree
+      id_attr_value = tree.join('_') 
+      tags = get_tags(html_options, {:value => to_s, :id => id_attr_value, :name=>get_html_name_attribute_value(tree)})
+      %Q{<input type="password" #{tags}/>}
+    end
+    #Returns string with html radio button tag
+    def radio_button(value, html_options = {})
+      tree = get_parents_tree
+      id_attr_value = tree.join('_') + "_#{value}"
+      name_attr_value = get_html_name_attribute_value(tree)
+      tags = get_tags(html_options, {:name => name_attr_value, :value=>value, :id=>id_attr_value, :checked=>"#{@value.capitalize==value.capitalize}"})
+      %Q{<input type="radio" #{tags}/>}
+    end
+    #Returns string with html label tag with for attribute set to the radio button of this object
+    def radio_button_label(radio_button_value, value = nil, html_options = {})
+      tree = get_parents_tree
+      for_attr_value = tree.join('_') + "_#{radio_button_value}"
+      value = radio_button_value.capitalize if value.nil?
+      tags = get_tags(html_options, {:for => for_attr_value})
+      %Q{<label #{tags}>#{ERB::Util::h(value)}</label>}
+      end
+    end
+    #Representation for objects which are nil
+    class NilClassRepresentation < Representation
+      #Returns self so the calls:
+      #nil_object.not_defined_method.another_not_defined_method
+      #want raise an error
+      def method_missing(method_name, *args)
+        return self
+      end
+      #Passed block shouldn't be called
+      def with_block(&block)
+      end
+      #Returns blank string
+      def to_s
+        return ''
+      end
+    end
+    #Representation for ActiveRecord::Base object's
+    class ActiveRecordRepresentation < Representation
+      #Form builder
+      def form(&block)
+        raise "You need to provide block to form representation" unless block_given?
+        content = @template.capture(self, &block)
+        @template.concat(@template.form_tag(@value))
+        @template.concat(content)
+        @template.concat("</form>")
+        self
+      end
+      #Forwards ActiveRecord invocation and wraps result in apropriate Representation
+      #Suppose that User extends ActiveRecord::Base :
+      #ar_user = User.new
+      #ar_user.nick = 'foo'
+      #user = r(ar_user) #user is now ActiveRecordRepresentation
+      #user.nick.text_field #method_missing will be called on user with method_name = 'nick' in which new method for user will be created and will be called. The newly created method will create new DefaultRepresentation with @value set to the string 'foo'. Next the text_field will be called on the newly created DefauleRepresentation
+      #
+      def method_missing(method_name, *args, &block)
+        method = <<-EOF
+            def #{method_name}(*args, &block)
+              @__#{method_name} ||= Representations.representation_for(@value.#{method_name}, @template, "#{method_name}", self)
+              @__#{method_name}.with_block(&block)
+              @__#{method_name} if block.nil?
+            end
+         EOF
+        ::Representations::ActiveRecordRepresentation.class_eval(method, __FILE__, __LINE__)
+
+        self.__send__(method_name, &block)
+      end
+    end
+    #Representation for TimeWithZone object 
+    class TimeWithZoneRepresentation < Representation
+      def select(passed_options = {}, html_options = {})
+        options = {:defaults => {:day => @value.day, :month => @value.month, :year => @value.year}}
+        options.merge!(passed_options)
+        tree = get_parents_tree
+        tree.pop
+        name = get_html_name_attribute_value(tree)
+        @template.date_select(name, @name, options, html_options)
+      end
+    end
+  end

data/lib/view_helpers.rb

@@ -0,0 +1,9 @@
+module Representations
+    module ViewHelpers
+        def r(model)
+            r = Representations.representation_for(model, self, model.class.to_s.downcase)
+            yield r if block_given?
+            r
+        end
+    end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+Kernel.load File.join(File.dirname(__FILE__), '..', 'init.rb')
+

data/representations.gemspec

@@ -0,0 +1,48 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{representations}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["\305\201ukasz Piestrzeniewicz", "Adam Sokolnicki"]
+  s.date = %q{2009-10-17}
+  s.description = %q{Rails helpers, including form builders are great to allow rapid development of applications and views.  
+They are procedural in nature and have hard time to adapt to complex models. They also live in a single namespace making it difficult to find which helpers apply to which models.  
+Resource representations change syntax to object oriented and model specific.}
+  s.email = %q{skimos00@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     "LICENSE.txt",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/representations.rb",
+     "lib/view_helpers.rb",
+     "rails/init.rb",
+     "representations.gemspec"
+  ]
+  s.homepage = %q{http://github.com/bragi/representations}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Changes syntax of rails helpers and form builders to object oriented and model specific}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: representations
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "\xC5\x81ukasz Piestrzeniewicz"
+- Adam Sokolnicki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-17 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: |-
+  Rails helpers, including form builders are great to allow rapid development of applications and views.  
+  They are procedural in nature and have hard time to adapt to complex models. They also live in a single namespace making it difficult to find which helpers apply to which models.  
+  Resource representations change syntax to object oriented and model specific.
+email: skimos00@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- .document
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- init.rb
+- lib/representations.rb
+- lib/view_helpers.rb
+- rails/init.rb
+- representations.gemspec
+has_rdoc: true
+homepage: http://github.com/bragi/representations
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Changes syntax of rails helpers and form builders to object oriented and model specific
+test_files: []
+