king_views 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Georg Leciejewski
+
+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.rdoc

@@ -0,0 +1,84 @@
+= KingViews
+
+This is the new offical home of KingViews(forked from schorsch)
+
+KingViews where extracted from SalesKing(https://www.SalesKing.eu) and consist 
+of three different view helpers, KingForm( dl || labeled forms, enhanced inputs ),
+KingList( dl, tables ) and KingFormat( date, money, percent )
+
+This stuff is not optimized(yet) to run seamlessly within any rails project.
+Fixes for rails 2.3.5 and of course 3.0 are needed. Some refacturing and of
+course testing(still stuck in SalesKing) should be done, leaving space for forks.
+
+== Install
+
+You must use HAML for your views .. the cure for erb eye cancer
+
+    gem install king_views
+
+
+== KingForm
+
+Clean up your forms with helpers in rails haml views, with support for:
+* dl or labeled forms
+* shorter syntax for inputs
+* fieldset support (section)
+* labels auto translated when present in I18n or Gettext
+* info-text for auto translated info after each input
+* bundle a couple of inputs under one label or dt incl. css class based counter for the wrapper
+* based on rails action view helpers so all parameters are passed through(nearly all) to the original versions
+
+=== Example
+    - dl_form_for @payment, :url => 'a path', :html => { :method => :post } do |f|
+      -f.section do
+        = f.hidden :lock_version
+        = f.text :amount, :class => 'required', :value=> 'a custom val'
+        = f.date :date, :title => t(:'from'), :info=>'Help me'
+        = f.selection :payment_method
+        - f.bundle 'status' do
+          = f.radio :new_status, :closed, :checked=>true
+          %span=t(:'status.closed')
+          = f.radio :new_status, :open
+          %span= t(:'activerecord.attributes.document.enum.status.open')
+      -f.actions do
+        = f.submit t(:'form.save')
+        = secondary_link_to t(:'link.cancel'), parent_path
+
+== KingList
+
+Use KingList for an easy markup inside your lists and detail views. Its not as
+extensive as KingForm and only provides the following:
+
+* easy to use tables for listings
+* dl-helper for detail views
+* action_icons & action_buttons(forms) for css enabled icon markup
+
+=== Example
+    # Definition list for detail views
+    - dl_for @invoice do |f|
+      = f.show :number
+      = f.show :date # auto-formated date field
+      = f.show :total # auto-formated money field
+
+    # table with header-klick sorting disabled
+    - table_for(@payments,{:sorting => false} ) do |t, payment|
+      - t.action_column do
+        = action_button 'delete', {:url=> 'some-path', :title => t(:'link.delete'), :method => :delete, :class=>'delete'}
+      = t.column :date
+      = t.column :amount, :td_options => {opt=>val}
+
+== KingFormat
+Provides a semi-automatic formatting of date, money, percent fields. The field
+types are defined inside a model. And the view helpers will show a nice output.
+
+=== Example:
+
+    #define date fields you model definition
+    class Invoice < ActiveRecord::Base
+      has_date_fields :date, :valid_until
+      has_money_fields :total, :price
+    end
+    # see above for usage in views
+
+== License
+Copyright (c) 2009 Georg Leciejewski, released under the MIT-LICENSE

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "king_views"
+    gem.summary = %Q{Ultraclean haml views with list and forms helpers for rails }
+    gem.description = %Q{Clean up your Forms using king_form for dl or labeled forms. Use king_list for an easy markup of tables in your lists and dl-enabled listings in your detail views. }
+    gem.email = "gl@salesking.eu"
+    gem.homepage = "http://github.com/salesking/king_views"
+    gem.authors = ["Georg Leciejewski"]
+    #gem.add_development_dependency "rspec", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc 'Generate king_views documentation.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'KingViews'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('king_form/lib/**/*.rb')
+  rdoc.rdoc_files.include('king_format/lib/**/*.rb')
+  rdoc.rdoc_files.include('king_list/lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/init.rb

@@ -0,0 +1,3 @@
+require "#{File.dirname(__FILE__)}/king_format/init"
+require "#{File.dirname(__FILE__)}/king_list/init"
+require "#{File.dirname(__FILE__)}/king_form/init"

data/king_form/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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/king_form/README.rdoc

@@ -0,0 +1,64 @@
+= KingForm
+
+Writing forms is is an enerving repetitive task. It already got easier through rails
+but still you have to huddle with a lot of html, erb markup and options around your fields.
+
+King forms internals are based on haml, rails' form helpers, I18n translations
+and a simplified syntax for fieldnames.
+
+Additionally it includes a nested_form_helper to easiely show related models in a form.
+
+== Example KingForm
+ruby code
+ - dl_form_for( current_object, :url => object_url, :html => { :id => 'productForm'} ) do |f|
+  - f.section 'Name & Number' do
+    = f.hidden :lock_version
+    = f.text :name, :class => 'required'
+    = f.text :number
+    = f.selection :category
+    = f.selection :quantity_unit, :choices => ['some', 'choices']
+  - f.section '' do
+    = f.selection :tax, :choices => ['tax1', 'tax2'], :include_blank => false
+    = f.text :price, :class => 'required'
+    - f.actions do
+      = f.submit t(:'form.save')
+      = link_to t(:'link.cancel'), object_path
+
+== Example Nested Forms
+
+The first thing you need to do is enable attributes on the association in the model.
+ruby code
+  class Project < ActiveRecord::Base
+    has_many :tasks
+    accepts_nested_attributes_for :tasks
+  end
+
+The partial for the nested object(one Task) should have the name of the associated element's type( or the partial to use)
+
+  ## projects/_task.html.erb
+  <div class="task">
+    <label>Title</label>
+    <%= f.text_field :title %>
+  </div>
+
+In the parent element's form (Project), call the render_nested_form method, with the collection of
+elements you'd like to render as the first argument.
+
+  ## projects/_form.html.erb
+  <%= f.render_nested_form(@project.tasks) %>
+
+That call will render the partial named _task.html.erb with each element in the supplied collection of tasks, wrapping
+the partial in a form builder (fields_for) with all the necessary arguments to produce a hash that will satisfy the
+tasks_attributes method(provided by Rails new accepts_nested_attributes_for).
+
+=== Options
+See comments in lib/nested_form_helper for full reference of options.
+You may want to add a few blank tasks to the bottom of your form; no need to do that in the controller anymore.
+
+  <%= f.render_nested_form(@project.tasks, :new => 3, :partial=>'some_partial', :locals=>..) %>
+
+
+
+This plugin was extracted from SalesKing where it was developed by Georg Ledermann
+and Georg Leciejewski
+Copyright (c) 2009 Georg Leciejewski, released under the MIT license

data/king_form/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the king_forms plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the king_forms plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'King-forms'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/king_form/init.rb

@@ -0,0 +1 @@
+require "#{File.dirname(__FILE__)}/lib/king_form"

data/king_form/lib/king_form.rb

@@ -0,0 +1,19 @@
+require "#{File.dirname(__FILE__)}/king_form/helper"
+require "#{File.dirname(__FILE__)}/king_form/overrides"
+require "#{File.dirname(__FILE__)}/king_form/builder/form_fields_overrides"
+require "#{File.dirname(__FILE__)}/king_form/builder/form_fields"
+require "#{File.dirname(__FILE__)}/king_form/builder/base"
+require "#{File.dirname(__FILE__)}/king_form/builder/definition_list"
+require "#{File.dirname(__FILE__)}/king_form/builder/labeled"
+require "#{File.dirname(__FILE__)}/king_form/nested_form_helper"
+
+# You need:
+# - haml
+# - mutlilang via I18n or gettext ??
+# -switch to allow default rails helper
+
+# extend AC with our helper module
+ActionController::Base.helper KingForm::Helper
+
+# include the nested_form helper method on the very top of FormBuilder
+ActionView::Helpers::FormBuilder.class_eval { include KingForm::NestedFormHelper }

data/king_form/lib/king_form/builder/base.rb

@@ -0,0 +1,238 @@
+module KingForm
+  module Builder
+    # Base Form Helper Class overrides most of rails build in form / field methods.
+    # This class is used in conjunction with haml and makes your templates ultra clean.
+    #
+    # To further specify the resulting html for form fields and their wrappers,
+    # subclass KingForm::Builder::Base.
+    #
+    # Subclasses must define the following methods:
+    #
+    # ==== def section
+    # Definition of a section inside a form. A section is a wrapper around fields
+    # which belong together. The topmost element should be(most of the time) a fieldset
+    # followed by a legend and the openeing definition list.
+    #         fieldset-> legend -> div -> ....
+    #         fieldset-> legend -> dl -> ...
+    # See child class Labeled and DefinitionList for examples.
+    #
+    # ==== def tag_wrapper
+    # Wrapping/display of field descriptions(labels) and input tags
+    #   => wrapped with div. actually no wrapping(see above):
+    #     fieldset-> div -> label -> input
+    #   => wrapped with dt / dd
+    #     fieldset-> dl -> dd -> dt -> input
+    #
+    #
+    # ==== def bundle
+    # handle fields which are displayed toghether inside a wrapper
+    class Base < ActionView::Helpers::FormBuilder
+      include KingForm::Builder::FormFields
+      include KingForm::Builder::FormFieldsOverrides
+      attr_accessor :no_wrap
+      def initialize(object_name, object, template, options, proc)
+        # Store builder configuration data (only used by "render_associated_form")
+        @config = options.delete(:config) || {}
+
+        super(object_name, object, template, options, proc)
+      end
+
+      # Create a section(fieldset) within a form
+      # A section is a group of related object information with name/value pairs,
+      # like all dates of an object or the users name fields(last/first/title/nick).
+      def section(title = nil, options = {}, &block)
+        #must be overwritten in inerit classes
+      end
+
+      # Show multiple inputs as bundle
+      def bundle(title = nil, options = {}, &block)
+      #must be redefined in inerit class
+      end
+
+      # For using with nested forms with associated records => contact => addresses
+      # Another Builder instance will be created. Make sure it's also a DefinitionsListsFormBuilder
+      #  and configuration data is available for the new created instance
+      def render_nested_form(associated, opts = {})
+        opts[:fields_for] = { :builder =>  KingForm::Builder::DefinitionList, :config => @config }
+        super(associated, opts)
+      end
+
+      
+      # wraps a list of action links/buttons in a td od div
+      # those wrappers can then be formated with css td.actions
+      # also see #ListHelper
+      #
+      # ===Example haml
+      #   = f.actions do
+      #     = link_to my_actions
+      #
+      #  <div class="actions">my actions</div>
+      #  <td class="actions">my actions</td>
+      #
+      def actions(options = {}, &block)
+        options[:class] ||= 'actions'
+          if @config[:table]
+            @template.haml_tag :td, @template.capture_haml(&block), options
+          else
+            @template.haml_tag :div, @template.capture_haml(&block), options
+          end
+      end
+
+      #build a table
+      def table(title, options = {}, &block)
+        # Capture the block (with analyzing the header titles)
+        @config[:table] = true
+        @config[:column_header] = []
+        @config[:row_number] = 0
+        content = @template.capture_haml(&block)
+
+        # Now build the whole table tag
+        result = @template.capture_haml do
+          @template.haml_tag :table, options.reverse_merge({ :summary => title }) do
+            @template.haml_tag :thead do
+              @template.haml_tag :tr do
+                @config[:column_header].each do |c|
+                  c[:options][:class] ||= ''
+                  if c == @config[:column_header].first
+                    c[:options][:class] << ' first'
+                  elsif c == @config[:column_header].last
+                    c[:options][:class] << ' last'
+                  end
+
+                  @template.haml_tag :th, c[:title], c[:options]
+                end
+              end
+            end
+            @template.haml_tag :tbody, content
+          end
+        end
+        @config[:table] = false
+
+        return result
+      end
+
+      # Build a single table row, only needed to be be able to render the table
+      # headers(th) 
+      def table_row(&block)
+        @config[:row_number] += 1
+        @template.concat "<tr> #{@template.capture(&block)}</tr>"
+      end
+
+     private
+      #  returns the current object
+      def current_object
+        # check for fields made with attribute_fu
+        if @object_name.to_s.match(/\[\w+_attributes\]/)
+          #field was constructed via attribute_fu: user[address_attributes][atLE1aPLKr3j9zabTJhScS]
+          @object
+        else
+          # Instance-Variable of the templates
+          @template.instance_variable_get("@#{@object_name}")
+        end
+      end
+
+      # returns the class of the current object
+      def current_class
+        current_object.class
+      end
+
+      # returns the value of an attribute belonging to the current object
+      def current_value(fieldname)
+        if current_object.is_a?(Hash)
+          current_object[fieldname]
+        else
+          current_object.send(fieldname) rescue nil
+        end
+      end
+
+
+      # Shortcut for using "content_tag", which exists in the context of the template
+      def content_tag(*args)
+        @template.content_tag(*args)
+      end
+
+      # Translate acts_as_enum dropdown field values either with I18n
+      # A key must be lokated in the language file under:
+      # "activerecord.attributes.client.enum.sending_methods.fax"
+      # "activerecord.attributes.client.enum.sending_methods.email"
+      # ==== Parameter
+      # fieldname<String,Symbol>:: The fieldname in the model which holds enum values from acts_as_enum plugin
+      # === Returns
+      # <Hash{'translated fldname'=>'value'}>::
+      def enum_values(fieldname)
+        # Check if there is a const in the class defined by acts_as_enum
+        return unless current_class.const_defined?(fieldname.to_s.upcase)
+        # Get Array with the values from this constant
+        values = current_class.const_get(fieldname.to_s.upcase)
+        # values are symbols as defined by "acts_as_enum"
+        if values && values.first.is_a?(Symbol)
+          values_with_translated_keys = {}
+          values.each do |value|
+            key = current_class.human_attribute_name("enum.#{fieldname.to_s}.#{value.to_s}")
+            values_with_translated_keys[key] = value.to_s
+          end
+          return values_with_translated_keys
+        else
+          #values are not symbols (probably not coming from acts_as_enum) =>return them unchanged
+          return values
+        end
+      end
+
+      # add titles to Input-Tag and embed/wrap in dt/dd
+      #   options: Hash with following keys
+      #     :dt => options for dt
+      #     :dd => options for dd
+      def tag_wrapper(fieldname_or_title, tags, options = {})
+        #overwrite in inherit class !!!
+      end
+
+      # Build a fields title/label with translation
+      # takes the class and fieldname (like  GetText ActiveRecord-Parser )
+      # ==== Parameter
+      # fieldname_or_title<String,Symbol>:: A string is directly returned.
+      # A Symbol is beeing looked up in I18n translation inside the models attribute namespace:
+      # => class.human_attribute_name(fieldname_or_title.to_s)
+      def build_title(fieldname_or_title)
+        if fieldname_or_title.is_a?(Symbol)
+          #i18n namespace under activerecord.attributes.model.attr_name
+          current_class.human_attribute_name(fieldname_or_title.to_s) if current_class.respond_to?(:human_attribute_name)
+        else
+          fieldname_or_title
+        end
+      end      
+
+      # Build span-tag with an info text after a field
+      # ==== Parameter
+      # fieldname_or_text<String/Symbol>:: static text value or a fieldname as symbol.
+      # If a symbol is given the translated text is taken from I18n translation file
+      def info_tag(fieldname_or_text)
+        case fieldname_or_text
+        when String #just use the plain string
+          value = fieldname_or_text
+        when Symbol # lookup the the field in i18n under activerecord.attributes.class.fieldname_info
+          trans = I18n.translate("#{current_class.name.underscore}.#{fieldname_or_text.to_s}_info",
+                                 :default => '',
+                                 :scope => [:activerecord, :attributes])
+          value = trans.blank? ? nil : trans
+        else
+          raise ArgumentError
+        end
+
+        value ? content_tag(:div, value, :class => 'info') : ''
+      end
+
+      
+      # Create the id of a field
+      # ==== Parameter
+      # name<String>::The name of the id
+      def build_id(name)
+        if current_object.blank?
+          name
+        else
+          "#{@object_name}_#{name}"
+        end
+      end
+
+    end #Class Base
+  end#Module Builder
+end#Module KingForm