listly 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8473d8c7b73747ae59f3b19810ac13c6581599b1
-  data.tar.gz: d7626d1d04b20f58b6e92ec3be74b33d2adea197
+  metadata.gz: 260001fcbec50c2260f25e34237d86b4549e8ec5
+  data.tar.gz: 494bdb187588c04fc29cc9ee0214797f5778ad31
 SHA512:
-  metadata.gz: 3c1a23f6267745dcf22ea072738fe90e76f733b04629bda641a768ccec648abe9fc29a0ac601624cc2366b384cbb76dbb85cd5bd3fd604a80b9cc3c95c976879
-  data.tar.gz: 386160249e032d4762b72f87c4ca22fb4ef2f46b528fce169beac46f85bdd792dfbdacdc7edb1dd634cf3f20c0774dde11b0b72d44f59f02dd701438299431f1
+  metadata.gz: 54f6b6cb9631ec143ec31f5c76db9a9498461817fb34705d902f11360e8046078d5f009f97025b11bc02758a7e56086036fbcfb36290cc1c05371c3369bc649f
+  data.tar.gz: b028e0e30cb6bafadf8571ee93853426ac2efdd5f17e74302ae7267eea7cb0bfa05ac3182cdf2d1021a88bfec41f25ca638e337b36646631faa2e9d1bcc37d26

data/Gemfile.lock

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

data/README.md

@@ -26,9 +26,103 @@ Or install it yourself as:
 
     $ gem install listly
 
+## Configuration
+
+Firstly in your rails config/application.rb - you need to set the two config variables
+for the listly gem. The :local_list_store is for the next release. It doesn't do anything just yet.
+The :local_list_constants, is a symbol of a simple module that needs to be loaded in the rails
+load process i.e. putting it in the lib folder will suffice. The module (see below) just needs
+to contain a list of constants and their respective values that relate to where the list data
+is stored. The default is to store this data in the i18n internatialisation files in
+config/locales. Anywhere will do since they all will be loaded!
+
+
+```ruby
+
+module YourRailsApp
+  class Application < Rails::Application
+    ...
+    config.listly.listly_store_location = :local_list_store
+    config.listly.listly_constants_module = :local_list_constants
+    ...
+  end
+end
+
+```
+
+Here is an example of the module and some sample constants that will be turned into lists.
+
+```ruby
+
+module LocalListConstants
+
+  STATE_TYPES = :state_type_hash
+  SEX_TYPES = :sex_type_hash
+
+end
+
+```
+
+The in the "config/locales/views/en.yml" (this can be in any of the locale files) you can
+put the respective data relating to the above constant values.
+
+```ruby
+
+  states_hash: [
+    {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: [
+    {code: 'male', name: 'Male'},
+    {code: 'female', name: 'Female'},
+    {code: 'notset', name: 'Not Set'}
+  ]
+
+```
+
+Listly will create a module from each constant with its respective data. It will create
+an internal class that holds instance properties and attr_reader access methods for each.
+i.e. "states_hash: code" will be the code attribute on the list etc..
+
 ## Usage
 
-TODO: Write usage instructions here
+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:
+
+```ruby
+
+require "mustache_extras"
+
+module Wrapper
+  module Person
+
+    class New < ::Stache::Mustache::View
+      include PageHeader
+      include Mustache::FormBuilder
+      include Wrapper::Person::Form
+      include SexTypeList   # <------ This is the included list module!
+
+```
+
+Then in the actual form... this is how you can use the list - i.e. the method
+"all_sex_types" was derived from the "SexType" module name and the "sex_type_code"
+and "sex_type_name" methods will populate the form with the relevant "code" and
+"name" data - that was pulled from your i18n locale file!
+
+
+```ruby
+
+sex_field: f.collection_select(:sex, all_sex_types, :sex_type_code, :sex_type_name, {
+  label: t('patients.sex'),
+  config: {
+    prompt: t('form.please_select'),
+  }
+}),
+
+```
 
 ## Development
 

data/lib/listly/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: listly
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Steve Forkin
@@ -156,7 +156,6 @@ files:
 - bin/console
 - bin/setup
 - lib/listly.rb
-- lib/listly/backup_lists.rb
 - lib/listly/base_list.rb
 - lib/listly/list_constants.rb
 - lib/listly/lists.rb

data/lib/listly/backup_lists.rb

@@ -1,110 +0,0 @@
-#
-module ListParent
-  #
-  # - creates items of the passed in item_class with the passed in type_prefix for code and name for list items
-  def all_list_items(type_prefix, item_class, list_items_hash = {})
-    list_items = []
-    list_items_hash.each do |item|
-      data = {}
-      item.each{ |key, value| data["#{type_prefix}_#{key}"] = "#{value}" }
-      list_items << Module.const_get("Lists::#{item_class}").new(data)
-    end
-    list_items
-  end
-
-  def list_item_name(all_items, code_field, name_field, list_item_code)
-    name = ''
-    all_items.map do |item|
-      if (item.send code_field) == list_item_code
-        name = item.send name_field
-      end
-    end
-    name
-  end
-
-  class MyListType
-    attr_accessor :list_hash # - this is for convenience methods in Rails
-
-    # - dynamically create the properties from the passed in hash at runtime
-    define_method :initialize do |args|
-      @list_hash = args
-
-      args.each do |name, value|
-        instance_variable_get("@#{name}")
-        instance_variable_set("@#{name}", value)
-      end
-    end
-
-    # - these are for convenience methods in Rails i.e. make lists behave like AR objects
-    def [](key)
-      list_hash[key.to_s]
-    end
-
-    def []=(key, value)
-      list_hash[key.to_s] = value
-    end
-  end
-
-end
-#
-module Lists
-  #
-  # List Class Names as Constants
-  TEST1_TYPE = :test1_types_hash
-  TEST2_TYPE = :test2_types_hash
-  #
-
-  # some convenience methods to create the list modules and class from the CONSTANT
-  class << self
-    # Returns a hash of class names to hash storage details as sym.
-    def list_name_constants
-      self.constants.each_with_object({}) do |name, hash|
-        # Ignore any class constants
-        next if (storage_location = Lists.const_get(name)).is_a?(Module)
-        hash[name] = storage_location
-      end
-    end
-
-    # Returns a module name from a constant name.
-    def module_name_for_list_name(name)
-      module_name = name.to_s.titleize.gsub(' ', '')
-    end
-
-    def class_name_for_item_name(name)
-      class_name = name.to_s.titleize.gsub(' ', '')
-    end
-  end
-end
-#
-Lists.list_name_constants.each do |name, store_hash|
-  list_module = Module.new
-  new_module_name = Lists.module_name_for_list_name(name)
-  # - add the new module to the list of constants!
-  list_module.module_eval do
-    include ListParent
-
-    define_method(:storage_location) { store_hash }
-
-    define_method("all_#{name.to_s.underscore.pluralize}") {
-      all_list_items(name.to_s.underscore.to_sym,
-        "#{new_module_name}::My#{new_module_name}", I18n.t("#{store_hash}"))
-    }
-
-    define_method("#{name.to_s.underscore}_name") {
-      list_item_name(Module.const_get("all_#{name.to_s.underscore.pluralize}"),
-        "#{name.to_s.underscore}_code".to_sym, "#{name.to_s.underscore}_name".to_sym,
-        list_item_code)
-    }
-  end
-  # - create the internal class that will hold the list data (hash)
-  klass = Class.new(ListParent::MyListType)
-
-  klass.send(:define_method, :attr_accessor) { "#{new_module_name}_code".to_sym }
-  klass.send(:define_method, :attr_accessor) { "#{new_module_name}_name".to_sym }
-  klass.send(:define_method, :code) { code }
-
-  # - add this class to the module constants
-  class_name = "My#{new_module_name}"
-  list_module.const_set(class_name, klass)
-  Lists.const_set(new_module_name, list_module)
-end