super_map 1.0.1 → 1.0.2

data/README

@@ -37,14 +37,17 @@ We define 2 SuperMaps:
 
 	end
 
-PAYMENT_TYPES defines options for payment_type field. Some labels are set
+PAYMENT_TYPES defines options for payment_type field. First parameter is a key
+that should be used to access this element instead of using value, which comes
+second as integer (and is possibly stored in database). Note that value might be
+totally random, it just needs be unique across elements. Some labels are set
 explicitly, for other options key.titleize will be used implicitly. We also
 defined a custom attribute :tax, which can be accessed using SuperMap#attribute
 method.
 
 PAYMENT_METHODS define translation_scope, which means labels will be present in
-translations file (I18n). :paypal will have custom label, which overrides
-translations.
+translations file (I18n - note that it's totally optional). :paypal will have
+custom label, which overrides translations.
 
 We can than use those SuperMaps to handle attributes for Payment instances:
 	
@@ -63,7 +66,6 @@ We can also use
 to get the form directly suitable to pass options to f.select helper method.
 
 
-
 To make things even simpler, we can use super_mapped_attr:
 
 	class Payment

data/Rakefile

@@ -14,7 +14,7 @@ PKG_FILES = FileList[
 
 spec = Gem::Specification.new do |s|
   s.name = "super_map"
-  s.version = "1.0.1"
+  s.version = "1.0.2"
   s.author = "Marek Janukowicz"
   s.email = "marek@janukowicz.net"
   s.homepage = "http://www.bitbucket.org/starware/super_map"

data/lib/super_map.rb

@@ -1,9 +1,11 @@
-begin
-  require 'i18n'
-rescue LoadError
-  nil # We don't really need I18n, but if it's not present, :translation_scope can't be used
+unless defined?( RAILS_ENV ) # We don't need these in Rails, as they are provided there
+  begin
+    require 'i18n'
+  rescue LoadError
+    nil # We don't really need I18n, but if it's not present, :translation_scope can't be used
+  end
+  require 'string_extensions'
 end
-require 'string_extensions'
 require 'super_mapped_attr'
 
 # Two-way hash with additional custom data, autogenerated labels and human
@@ -79,6 +81,11 @@ class SuperMap
 
   # Creates new list.
   # Elements - arrays with arguments for Element.new (key, value, attributes)
+  #   key - a Symbol representing the element (to be used within the app to
+  #     access this element)
+  #   value - integer, string or whatever: real, meaningful value of element
+  #   attributes - any additional attributes this element might need in form of
+  #     a Hash
   # Options (optional last argument): 
   #   :translation_scope - where to find translated labels/descriptions
   #   :unknown_value_fatal - whether to raise an exception when accessing

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: super_map
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Marek Janukowicz
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-16 00:00:00 +02:00
+date: 2011-02-23 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -30,12 +30,12 @@ extra_rdoc_files:
 files: 
 - Rakefile
 - README
-- lib/super_map.rb
-- lib/super_mapped_attr.rb
 - lib/string_extensions.rb
+- lib/super_mapped_attr.rb
+- lib/super_map.rb
+- test/super_map_test.rb
 - test/super_mapped_attr_test.rb
 - test/en.yml
-- test/super_map_test.rb
 has_rdoc: true
 homepage: http://www.bitbucket.org/starware/super_map
 licenses: []