listly 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 260001fcbec50c2260f25e34237d86b4549e8ec5
-  data.tar.gz: 494bdb187588c04fc29cc9ee0214797f5778ad31
+  metadata.gz: 06730e4bf6465e967b61301ae338d24863e58c6a
+  data.tar.gz: cfd63cdd96c7192d9a1846fc3ca723ea0c5fc692
 SHA512:
-  metadata.gz: 54f6b6cb9631ec143ec31f5c76db9a9498461817fb34705d902f11360e8046078d5f009f97025b11bc02758a7e56086036fbcfb36290cc1c05371c3369bc649f
-  data.tar.gz: b028e0e30cb6bafadf8571ee93853426ac2efdd5f17e74302ae7267eea7cb0bfa05ac3182cdf2d1021a88bfec41f25ca638e337b36646631faa2e9d1bcc37d26
+  metadata.gz: 2143ec5091d4ac1eb46602ac782b612c34e8067390c6a6059e6e4308a15574a772c706600963428d1b23e19c06f8ace9eb7e571e0aea34f6166d5776cd5a133b
+  data.tar.gz: 7015231ed9ebbbb9a218aeb8e6787f284efe624cf27ed5209a05d23a3c971c4d84a1b0e4d418920ea559b1473c319b5484dd8e4a89c4aa3c6151106453cdb190

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    listly (0.1.3)
+    listly (0.1.4)
       rails (>= 4.1.1)
 
 GEM

data/README.md

@@ -43,7 +43,7 @@ module YourRailsApp
   class Application < Rails::Application
     ...
     config.listly.listly_store_location = :local_list_store
-    config.listly.listly_constants_module = :local_list_constants
+    config.listly.listly_constants_module = :local_list_constants # <--- ModuleName as symbol
     ...
   end
 end
@@ -54,10 +54,10 @@ Here is an example of the module and some sample constants that will be turned i
 
 ```ruby
 
-module LocalListConstants
+module LocalListConstants   # <------ Module name see the symbol "listly_constants_module" above
 
-  STATE_TYPES = :state_type_hash
-  SEX_TYPES = :sex_type_hash
+  STATE_TYPES = :state_type_hash  # <----- see the hash stored in locales below
+  SEX_TYPES = :sex_type_hash      # <----- see the hash stored in locales below
 
 end
 
@@ -68,13 +68,13 @@ put the respective data relating to the above constant values.
 
 ```ruby
 
-  states_hash: [
+  state_types_hash: [   # <------- Array of hashes - name corresponds to constants see above
     {code: 'act', name: 'ACT', desc: 'Australian Capital Teritory'},
     {code: 'nsw', name: 'NSW', desc: 'New South Wales'},
     {code: 'nt', name: 'NT', desc: 'Northern Teritory'},
     {code: 'qld', name: 'QLD', desc: 'Queensland'},
   ]
-  sex_types_hash: [
+  sex_types_hash: [     # <------- Array of hashes - name corresponds to constants see above
     {code: 'male', name: 'Male'},
     {code: 'female', name: 'Female'},
     {code: 'notset', name: 'Not Set'}
@@ -103,7 +103,8 @@ module Wrapper
       include PageHeader
       include Mustache::FormBuilder
       include Wrapper::Person::Form
-      include SexTypeList   # <------ This is the included list module!
+      include SexTypes   # <------ This is the included list module - see the SEX_TYPES
+                         # constant in the LocalListConstants module above
 
 ```
 
@@ -122,6 +123,13 @@ sex_field: f.collection_select(:sex, all_sex_types, :sex_type_code, :sex_type_na
   }
 }),
 
+# 'all_sex_types' --> is a listly defined method to get the whole list
+# 'sex_type_code' --> is a listly defined attribute on the inner class
+# 'sex_type_name' --> is a listly defined attribute on the inner class
+
+# NB: The gem creates attributes from the names of the hash codes and gives the attributes
+# values according to the hash values - i.e. from the data in the i18n stored array of hashes!
+
 ```
 
 ## Development

data/lib/listly/version.rb

@@ -1,3 +1,3 @@
 module Listly
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: listly
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Steve Forkin