king_views 1.0.5 → 1.1.0

data/README.rdoc

@@ -28,6 +28,8 @@ Clean up your forms with helpers in rails haml views, with support for:
 * 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
 
+Also see README in KingForm: http://github.com/salesking/king_views/tree/master/king_form/
+
 === Example
     - dl_form_for @payment, :url => 'a path', :html => { :method => :post } do |f|
       -f.section do
@@ -53,23 +55,29 @@ extensive as KingForm and only provides the following:
 * dl-helper for detail views
 * action_icons & action_buttons(forms) for css enabled icon markup
 
-=== Example
+Also see README in KingList: http://github.com/salesking/king_views/tree/master/king_list/
+
+=== Quick 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
+      = f.show :date # auto-formated date field see KingFormat
+      = f.show :total # auto-formated money field see KingFormat
 
-    # table with header-klick sorting disabled
+    # table with header-klick sorting disabled and icons in first column
     - table_for(@payments,{:sorting => false} ) do |t, payment|
       - t.action_column do
+        = action_icon :edit, edit_payment_path(payment)
         = 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.
+types are defined inside each model. And the view helpers will show a nice output.
+
+Also see README http://github.com/salesking/king_views/tree/master/king_format/
 
 === Example:
 

data/VERSION

@@ -1 +1 @@
-1.0.5
+1.1.0

data/king_form/lib/king_form/builder/form_fields.rb

@@ -8,7 +8,7 @@ module KingForm
       # Generate input tag with title for text editing
       # ==== Example
       # 1) text :name
-      # 2) text :name, :title => 'Your Name:', :value => @the_name, :size=>30, .maxlength=>35
+      # 2) text :name, :title => 'Your Name:', :value => @the_name, :size=>30, :maxlength=>35
       #
       # ==== Parameter
       # fieldname<Symbol, String>:: The field name of the current object
@@ -268,7 +268,7 @@ module KingForm
         end
 
         title = options.delete(:title) || build_title(fieldname)
-        value = options.delete(:value) || @template.formatted_value(current_object, fieldname)
+        value = options.delete(:value) || @template.strfval(current_object, fieldname)
 
         if info_text = options.delete(:info) #add info tag if info test given
           value << info_tag(info_text)

data/king_form/test/king_forms_test.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
-
-class King-formsTest < ActiveSupport::TestCase
+# yes i know ... big TODO, currently implicitly tested at salesking.eu which
+# makes pretty heavy use of it
+class KingFormTest < ActiveSupport::TestCase
   # Replace this with your real tests.
   test "the truth" do
     assert true

data/king_format/README.rdoc

@@ -1,20 +1,37 @@
 = KingFormat
+
+Define fields being of type date, currency or percent.  When the fields are shown
+within KingList/KingForm views, their format is detected and the output is
+automatically formatted. Default formats of date and currency fields can be set
+and both also take te current I18n.locale into account.
+
 KingFormat consists of two different formatting helper regions:
 
 == Model
-Define fields being of type date, money or percent.  When the fields are shown in the
-views, their format is detected and the output is looking nice.
+
+This is where you define the type of fields/attributes. Of course the model
+should somehow respond to those method names.
+
+  class Document
+    has_money_fields :gross_total, :net_total
+    has_date_fields :created_at, :date
+    has_percent_fields :discount
+    ...
+  end
 
 == View & Helper
-Output any model value through the function formatted_value() to ensure a consistent output.
 
-There are select values for money-symbols and date formatting.
+Output any model value through the function strfval() to ensure a consistent output.
+Further on you find select values for money-symbols and date formatting.
+
+A simple HAML example, without hussles:
 
+  - dl_for(current_object) do |f|
+    = f.show :net_total
+    = f.show :gross_total
+    = f.show :date
+    = f.show :discount
+    = f.show :net_total, :value=>strfval(current_object, :net_total)
 
-== Example
-In a Model
-  has_money_fields :amount
-  has_date_fields :subscription_start
-  has_percent_fields :tax
 
-Copyright (c) 2009 Georg Leciejewski, released under the MIT license
+Copyright (c) 2009-2010 Georg Leciejewski, released under the MIT license

data/king_format/lib/helpers/formatting_helper.rb

@@ -6,19 +6,21 @@ module KingFormat
     # Get a nice formatted string for an object attribute value.
     #
     # ==== Parameters
-    # object<Object>:: The object on which the given fieldname will be called => object.send(fieldname), to get the value
-    # fieldname<String>:: Name of the field for which to get a value
-    # value<String|Symbol|Date|FalseClass|TrueClass|...>::The value to display. When set this will be used instead of asking the object for its value.
+    # object<Object>:: The object on which the given fld name will be called
+    # => object.send(fld), to get the value
+    # fld<String>:: Name of the field for which to get a value
+    # val<String|Symbol|Date|FalseClass|TrueClass|...>::The value to display.
+    # When set this will be used instead of asking the object for its value.
     # See types for more
     # opts<Hash{Symbol=>String}>:: Options
     #  
     # ==== Options opts
-    #  currency<Hash{Symbol=>String}>:: Currency settings to format string as a money like found in rails I18n. or see rails number_helper.
-    #  When set, object AND fieldname must be set and the field must be in money_fields (via: has_money_fields)
+    #  currency<Hash{Symbol=>String}>:: Currency settings to format string as a money like found in rails I18n.
+    #  or see rails number_helper.
+    #  When set, object AND fld must be set and the field must be in money_fields (via: has_money_fields)
     #  Alternatively you can call the method with currency options set which will also lead to money rendering
     #  format -> defaults to :html returned html string has escaped html entities
     #
-    #
     # ==== AutoDetect Types
     # A value is formatted according to its type which we try to detect.
     #   <Symbol>:: assume a value from acts_as_enum
@@ -27,81 +29,92 @@ module KingFormat
     #   <MoneyField String>:: coming from a has_percent_fields, formats the number with number_to_percentage_auto_precision
     #   <PercentField String>:: comming from has_money_fields I18n formats as money string
     #
-    def formatted_value(object, fieldname, value=nil, opts={})
-      # If no value given, call fieldname on object to get the current value
-      value ||= if object.respond_to?(fieldname)
-        #return the content(a pointer it) or an empty string.
-        object.send(fieldname) || ''
-      else #field is not available in object
-        nil
-      end
-
+    def strfval (object, fld, val=nil, opts={})
+      # If no value given, call fld on object to get the current value
+      #return the content(a pointer) or an empty string OR  nil of field is not available
+      val ||= object.respond_to?(fld) ? ( object.send(fld) || '') : nil
       # Autodetect value type
-      if value.nil?
+      if val.nil?
         nil
-      elsif value.is_a?(Symbol) # enum value from acts_as_enum
-        translated_enum_value(object, fieldname, value)
-      elsif value.is_a?(DateTime) || value.is_a?(Time)  #|| value.is_a?(Date)
-        I18n.localize(value)
-      elsif value.is_a?(TrueClass) || value.is_a?(FalseClass)
-        value ? t(:'sk.yes') : t(:'sk.no')
-      elsif (object.class.is_percent_field?(fieldname) rescue nil)
-        (value && !value.blank?) ? number_to_percentage_auto_precision(value) : ''
-      elsif (object.class.is_money_field?(fieldname) rescue nil) || opts[:currency] # field is defined as money field OR currency options are passed in
-        # get currency from opts or company or fallback into i18n
-        settings = opts[:currency] || default_currency_format
-        # display with a rounding of 2 despite precision defined in company settings .. quick and dirty
-        #  .. other option would be to define such in has_money_fields via method missing or so 
-        if fieldname.to_s[/_round$/] # invoice.price_total_round
-          settings[:precision] = 2
-        end
-        number_to_currency(value, settings.merge({:locale => I18n.locale}))
-      elsif ( value.is_a?(Date) || (object.class.is_date_field?(fieldname) rescue nil) || opts[:date] ) #field is defined as date field OR date options are passed in
-        return value if value.blank? # blank value can occur when a is_date_field is empty
-        # get date from opts or company or fallback into i18n
+      elsif val.is_a?(Symbol) # enum value from acts_as_enum
+        translated_enum_value(object, fld, val)
+      elsif val.is_a?(DateTime) || val.is_a?(Time)  #|| val.is_a?(Date)
+        I18n.localize(val)
+      elsif val.is_a?(TrueClass) || val.is_a?(FalseClass)
+        val ? t(:'sk.yes') : t(:'sk.no')
+      elsif (object.class.is_percent_field?(fld) rescue nil)
+        (val && !val.blank?) ? number_to_percentage_auto_precision(val) : ''
+      elsif (object.class.is_money_field?(fld) rescue nil) || opts[:currency]
+        # field is defined as money field OR currency options are passed in        
+        strfmoney(val, opts[:currency])
+      elsif ( val.is_a?(Date) || (object.class.is_date_field?(fld) rescue nil) || opts[:date] )
+        # field is defined as date field OR date options are passed in
+        return val if val.blank? # blank value can occur when a is_date_field is empty
+        # get date from opts or default or fallback into i18n
         format = opts[:date] || default_date_format
-        format.blank? ? ::I18n.localize(value) : value.strftime(format)
+        format.blank? ? ::I18n.localize(val) : val.strftime(format)
       else
        if opts[:format] == :html
           # Change HTML tag characters to entities
-          ERB::Util.html_escape(value)
+          html_escape(val) # from Haml::Helpers
         else
-          #Copy->val.dup because obj.send(fieldname) returns pointer, and subsequent calls
-          #may then alter the real value f.ex val = formatted_value(yx) + "info text"
+          #Copy->val.dup because obj.send(fld) returns pointer, and subsequent calls
+          #may then alter the real value f.ex val = strfval(yx) + "info text"
           # rescue for Fixnums are not dup -able, cause its a call by value
-          value.blank? ? value : ( value.dup rescue value )
+          val.blank? ? val : ( val.dup rescue val )
         end
       end
-    end #formatted
+    end #strfval
+
+    # Formats the given value using rails number_to_currency. Get currency
+    # from options hash or @default_currency_format or i18n as fallback
+    def strfmoney(val, opts={})
+      settings = opts || default_currency_format
+      number_to_currency(val, settings.merge({:locale => I18n.locale}))
+    end
+
+    # Deprecated, to be dropped
+    def formatted_value(object, fld, val=nil, opts={})
+      ::ActiveSupport::Deprecation.warn('"formatted_value" has been deprecated, use the "strfval" instead. Func will be removed within next releases', caller)
+      strfval(object, fld, val, opts)
+    end
 
     # Returns the default date formatting.
     # The returned string is passed to strftime(format)
-    # TODO: NoGo since one cannot expect a company to be present
     # === Returns
     # <String>:: strftime compatible string
     def default_date_format
-      Company.current.date_format rescue nil
+      @default_date_format || {}
     end
-
-    # Returns the default currency formatting from Company.current => Thread var
-    # TODO: NoGo since one cannot expect a company to be present
+   
+    # Returns the default currency formatting
     # The returned hash is used in rails number_to_currency helper
     # === Returns
     # <Hash>:: number_to_currency compatible options hash
     def default_currency_format
-      Company.current.currency rescue {}
+      @default_currency_format || {}
     end
-
-    # Formats a number to the visible decimal places if there are more than the
-    # given prescision
-    # 
+    
+    # Formats a number to the visible decimal places. If there are more decimal 
+    # places than the given prescision those are used.
+    #
+    # === Examples
+    #   auto_precision(1.2340, 2)
+    #   => "1.234"
+    #   
+    #   auto_precision(1.234500)
+    #   => "1.2345"
+    #   
+    #   auto_precision(1.2345, 5)
+    #   => "1.23450"
+    #
     # ====Parameter
     # number<Float>:: The number to format
     # precs<Integer>:: The precision to which to round the number
     # ==== Return
     # nil if number is nil
-    # <String> with formatted number
-    def money_auto_precision(number, precs)
+    # <Float> with formatted number
+    def auto_precision(number, precs=2)
       return unless number
       decimals = number.to_s[/\.(.*)\z/, 1] #15.487 => 487
       precision = (decimals && decimals.length > precs) ? decimals.length : precs
@@ -110,4 +123,5 @@ module KingFormat
     end
 
   end # FormattingHelper
+  
 end # KingFormat

data/king_format/lib/king_format.rb

@@ -1,3 +1,4 @@
+require 'active_support/deprecation'
 # KingFormat
 $LOAD_PATH << File.expand_path(File.dirname(__FILE__))
 

data/king_format/test/king_format_test.rb

@@ -1,5 +1,6 @@
 require 'test_helper'
-
+# yes i know ... big TODO, currently implicitly tested at salesking.eu which
+# makes pretty heavy use of it
 class KingFormatTest < ActiveSupport::TestCase
   # Replace this with your real tests.
   test "the truth" do

data/king_list/lib/king_list/builder/show.rb

@@ -49,7 +49,7 @@ module KingList
         caption = options.delete(:caption) || object.class.human_attribute_name(field_name.to_s)
 
         # Use given value or take formatted value as default
-        value = options.delete(:value) || @template.formatted_value(object, field_name)  || ' '
+        value = options.delete(:value) || @template.strfval(object, field_name)  || ' '
 
         # if link option is set, then link to this object
         if link = options.delete(:link)

data/king_list/lib/king_list/builder/table.rb

@@ -90,7 +90,7 @@ module KingList
 
           when :content
             # Use given value (or formatted value as default)
-            value = options.delete(:value) || @template.formatted_value(object, field_name, value)
+            value = options.delete(:value) || @template.strfval(object, field_name, value)
 
             # If link option is set, then link to this
             # === Example            #

data/king_list/test/king_list_test.rb

@@ -1,5 +1,6 @@
 require 'test_helper'
-
+# yes i know ... big TODO, currently implicitly tested at salesking.eu which
+# makes pretty heavy use of it
 class KingListTest < ActiveSupport::TestCase
   # Replace this with your real tests.
   test "the truth" do

data/king_views.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{king_views}
-  s.version = "1.0.5"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2010-08-31}
+  s.date = %q{2010-09-25}
   s.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. }
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [
@@ -21,11 +21,9 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
-     "init.rb",
      "king_form/MIT-LICENSE",
      "king_form/README.rdoc",
      "king_form/Rakefile",
-     "king_form/init.rb",
      "king_form/lib/king_form.rb",
      "king_form/lib/king_form/builder/base.rb",
      "king_form/lib/king_form/builder/definition_list.rb",
@@ -35,13 +33,11 @@ Gem::Specification.new do |s|
      "king_form/lib/king_form/helper.rb",
      "king_form/lib/king_form/nested_form_helper.rb",
      "king_form/lib/king_form/overrides.rb",
-     "king_form/tasks/king_forms_tasks.rake",
      "king_form/test/king_forms_test.rb",
      "king_form/test/test_helper.rb",
      "king_format/MIT-LICENSE",
      "king_format/README.rdoc",
      "king_format/Rakefile",
-     "king_format/init.rb",
      "king_format/lib/helpers/date_helper.rb",
      "king_format/lib/helpers/formatting_helper.rb",
      "king_format/lib/helpers/money_helper.rb",
@@ -49,20 +45,17 @@ Gem::Specification.new do |s|
      "king_format/lib/model_mixins/has_date_fields.rb",
      "king_format/lib/model_mixins/has_money_fields.rb",
      "king_format/lib/model_mixins/has_percent_fields.rb",
-     "king_format/tasks/king_format_tasks.rake",
      "king_format/test/king_format_test.rb",
      "king_format/test/test_helper.rb",
      "king_list/MIT-LICENSE",
      "king_list/README.rdoc",
      "king_list/Rakefile",
-     "king_list/init.rb",
      "king_list/lib/king_list.rb",
      "king_list/lib/king_list/app_helper.rb",
      "king_list/lib/king_list/builder/show.rb",
      "king_list/lib/king_list/builder/table.rb",
      "king_list/lib/king_list/list_helper.rb",
      "king_list/lib/king_list/overrides.rb",
-     "king_list/tasks/king_list_tasks.rake",
      "king_list/test/king_list_test.rb",
      "king_list/test/test_helper.rb",
      "king_views.gemspec",

data/lib/king_views.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: king_views
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 5
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-31 00:00:00 +02:00
+date: 2010-09-25 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -33,11 +33,9 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- init.rb
 - king_form/MIT-LICENSE
 - king_form/README.rdoc
 - king_form/Rakefile
-- king_form/init.rb
 - king_form/lib/king_form.rb
 - king_form/lib/king_form/builder/base.rb
 - king_form/lib/king_form/builder/definition_list.rb
@@ -47,13 +45,11 @@ files:
 - king_form/lib/king_form/helper.rb
 - king_form/lib/king_form/nested_form_helper.rb
 - king_form/lib/king_form/overrides.rb
-- king_form/tasks/king_forms_tasks.rake
 - king_form/test/king_forms_test.rb
 - king_form/test/test_helper.rb
 - king_format/MIT-LICENSE
 - king_format/README.rdoc
 - king_format/Rakefile
-- king_format/init.rb
 - king_format/lib/helpers/date_helper.rb
 - king_format/lib/helpers/formatting_helper.rb
 - king_format/lib/helpers/money_helper.rb
@@ -61,20 +57,17 @@ files:
 - king_format/lib/model_mixins/has_date_fields.rb
 - king_format/lib/model_mixins/has_money_fields.rb
 - king_format/lib/model_mixins/has_percent_fields.rb
-- king_format/tasks/king_format_tasks.rake
 - king_format/test/king_format_test.rb
 - king_format/test/test_helper.rb
 - king_list/MIT-LICENSE
 - king_list/README.rdoc
 - king_list/Rakefile
-- king_list/init.rb
 - king_list/lib/king_list.rb
 - king_list/lib/king_list/app_helper.rb
 - king_list/lib/king_list/builder/show.rb
 - king_list/lib/king_list/builder/table.rb
 - king_list/lib/king_list/list_helper.rb
 - king_list/lib/king_list/overrides.rb
-- king_list/tasks/king_list_tasks.rake
 - king_list/test/king_list_test.rb
 - king_list/test/test_helper.rb
 - king_views.gemspec

data/init.rb

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

data/king_form/init.rb

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

data/king_form/tasks/king_forms_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :king_forms do
-#   # Task goes here
-# end

data/king_format/init.rb

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

data/king_format/tasks/king_format_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :king_format do
-#   # Task goes here
-# end

data/king_list/init.rb

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

data/king_list/tasks/king_list_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :king_list do
-#   # Task goes here
-# end