listly 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06730e4bf6465e967b61301ae338d24863e58c6a
-  data.tar.gz: cfd63cdd96c7192d9a1846fc3ca723ea0c5fc692
+  metadata.gz: a63289d6cef2f01ec2176bda5392cb6647864d24
+  data.tar.gz: 7ba115c2d0729862edcc777b8386877654f6cea2
 SHA512:
-  metadata.gz: 2143ec5091d4ac1eb46602ac782b612c34e8067390c6a6059e6e4308a15574a772c706600963428d1b23e19c06f8ace9eb7e571e0aea34f6166d5776cd5a133b
-  data.tar.gz: 7015231ed9ebbbb9a218aeb8e6787f284efe624cf27ed5209a05d23a3c971c4d84a1b0e4d418920ea559b1473c319b5484dd8e4a89c4aa3c6151106453cdb190
+  metadata.gz: 90fb1b1b0e6ac67ca2fcfa426cf2eccc492d37710e140e6b845a683e98ff657a29232c331faa4ecd284802d6b837a147f8ecfde54ae786863cc8fb0d04549414
+  data.tar.gz: fecd689192a0d2f16bff4578a53483bab9f0430587473640a9bcf93c8ca977b58fcc5fbd42d79f1018049a04dc933fdfe21f696c6c98a891032a664c5478b474

data/README.md

@@ -39,9 +39,13 @@ config/locales. Anywhere will do since they all will be loaded!
 
 ```ruby
 
+# your module needs to be loaded/required before the application starts such as
+require File.dirname(__FILE__) + '/../lib/local_list_constants'
+
 module YourRailsApp
   class Application < Rails::Application
     ...
+    # Then the settings need to be included in the rails start up process
     config.listly.listly_store_location = :local_list_store
     config.listly.listly_constants_module = :local_list_constants # <--- ModuleName as symbol
     ...
@@ -88,6 +92,28 @@ i.e. "states_hash: code" will be the code attribute on the list etc..
 
 ## Usage
 
+### To test this in the Rails console:
+
+```ruby
+rails c
+
+# Then create a dummy test class & include one of your lists - such as the Sex List above
+class DummyList
+  include Listly::SexTypes
+end
+
+test_list = DummyList.new
+
+# then to see all items in the list
+
+test_list.all_sex_types  # - this will give you an array of all the sex types..
+
+=> [#<Listly::SexTypes::MySexTypes:0x000001078a13f0 @list_hash={"sex_types_code"=>"male", "sex_types_name"=>"Male"}, @sex_types_code="male", @sex_types_name="Male">, #<Listly::SexTypes::MySexTypes:0x000001078a0720 @list_hash={"sex_types_code"=>"female", "sex_types_name"=>"Female"}, @sex_types_code="female", @sex_types_name="Female">, #<Listly::SexTypes::MySexTypes:0x0000010789ba18 @list_hash={"sex_types_code"=>"notset", "sex_types_name"=>"Not Set"}, @sex_types_code="notset", @sex_types_name="Not Set">]
+
+```
+
+### How to use this in a view template and or rails form:
+
 To therefore use this in a view template in rails or a form - you simply need to include
 the module with the list into the view template. I frequently use mustache view wrappers
 which would look like this:
@@ -103,7 +129,7 @@ module Wrapper
       include PageHeader
       include Mustache::FormBuilder
       include Wrapper::Person::Form
-      include SexTypes   # <------ This is the included list module - see the SEX_TYPES
+      include ListLy::SexTypes   # <------ This is the included list module - see the SEX_TYPES
                          # constant in the LocalListConstants module above
 
 ```

data/lib/listly/railtie.rb

@@ -1,8 +1,6 @@
 #
 module Listly
   class Railtie < Rails::Railtie
-    #
-    puts "\n\n Loading Railtie..\n\n"
     #
     # enable namespaced configuration in Rails environments
     config.listly = ActiveSupport::OrderedOptions.new

data/lib/listly/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: listly
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Steve Forkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler