demeler 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0c386f96ecc1bd387757913d8c06df79c31a705
-  data.tar.gz: bed41140c85456d8d829e8b9919bbc70b9a7d838
+  metadata.gz: acfebb387fbe7468614262a490e3a139cc473a93
+  data.tar.gz: ffc63a2408ee1fa55953579cd7a3a7a0b88c4ea2
 SHA512:
-  metadata.gz: 5a75c02f4294c9da6b8fe6159c274c05a793c2ce2a31c90815f677723082b12d1117c0366543cc0fb08878442510d1d348af1520d3a344ec8aed1b53941109aa
-  data.tar.gz: c6eff11ee04f5a3b2f95f5938b5ed3f3ade2de6b158141bb3ce79f7683b2b38a738888fb7264f92ebdee7d0ac01713ac08f88645b81dddcddc7970cb696e23ed
+  metadata.gz: 3faea11d3c64618169f3fa6f99d7adb928a2c0b1c454f8d26150adbca80c81cedcc5de25f580361efdc9318b8de8ea003d1e724e592e7e3c37995b73b9e3dd81
+  data.tar.gz: e3912710539a702240427b371c896f3f88fc9f778fd64713301faf2fe2223dca3fcbb4196a239da42bb58e9342e7880f6ba81ad1f6144734896ef2262b744b1d

data/CHANGELOG.md

@@ -1,4 +1,9 @@
+# 1.0.2
+
+* Renamed the 'session' variable to be 'usr'. It's become clear to me that the only way a script can access data passed from the controller to the script is through this variable: therefore, it ought to have a generic name. The variable usr will have whatever is passed in through `new` or `build`.
+
 # 1.0.1
+
 * Changed the `clear` method to return self so that clear can be chained.
 * Corrected some of the comments above individual methods.
 * Made some corrections and additions to the README.
@@ -6,7 +11,9 @@
 * Added an argument to `build` and `initialize` to allow a session variable to be passed through.
 * Corrected a problem with the `select` control in that the attributes were not being applied.
 * Added a variable to `build` and `initialize` to be able to pass through a user argument. I called it `session` because that's what it would commonly be used for, but you could pass anything and access it in your Demeler code. For example, if you needed session _and_ some other variables, you would just pass them all in a Hash, including session.
+* Added a .gitignore file.
 
 
 # 1.0.0
+
 * Initial version.

data/README.md

@@ -276,7 +276,7 @@ Opts represents a Hash with tag attributes.
 
 ## Reference Guide
 
-### def self.build(obj=nil, gen_html=false, session={}, &block)
+### def self.build(obj=nil, gen_html=false, usr=nil, &block)
 
 This is the main Demeler call used to build your HTML. This call uses your code in the block, so it makes no sense to call `build` without a block.
 
@@ -284,17 +284,17 @@ Name | Type | Value
 ---- | ---- | -----
 obj | Hash+ | An object to use to get values and error messages.
 gen_html | Boolean | Create formatted HTML (true), or compact HTML (false: default).
-session | Hash | A variable meant to pass a session in a web server, but you can use it for passing any other value as well. _This value is for the caller's use and is not used by Demeler._
+usr | * | A variable meant to pass a session in a web server, but you can use it for passing any other value as well. _This value is for the caller's use and is not used by Demeler._
 block | Proc | The block with your code.
 
-### def initialize(obj=nil, session={}, &block)
+### def initialize(obj=nil, usr=nil, &block)
 
 Initialize sets up the initial conditions in Demeler, and is called by `new`.
 
 Name | Type | Value
 ---- | ---- | -----
 obj | Hash+ | An object to use to get values and error messages.
-session | Hash | A variable meant to pass a session in a web server, but you can use it for passing any other value as well. _This value is for the caller's use and is not used by Demeler._
+usr | Hash | A variable meant to pass a session in a web server, but you can use it for passing any other value as well. _This value is for the caller's use and is not used by Demeler._
 block | Proc | The block with your code.
 
 ### def clear

data/lib/demeler/version.rb

@@ -1,4 +1,4 @@
 module Version
-  VERSION = "1.0.1"
-  MODIFIED = "2017-06-10"
+  VERSION = "1.0.2"
+  MODIFIED = "2017-06-12"
 end

data/lib/demeler.rb

@@ -21,7 +21,7 @@
 # Ruby Sequel.
 
 class Demeler
-  attr_reader :out, :obj, :session
+  attr_reader :out, :obj, :usr
 
   # These calls are effectively generated in the same way as 'text' input
   # tags. Method_missing just does a substitution to implement them.
@@ -35,11 +35,11 @@ class Demeler
   #
   # @param [object] obj a Sequel::Model object, or Hash object with an added 'errors' field.
   # @param [boolean] gen_html A flag to control final output: true=>formatted, false=>compressed.
-  # @param [Hash] session The session variable from the caller, although it can be anything because Demeler doesn't use it.
+  # @param [*] usr The usr variable from the caller, although it can be anything because Demeler doesn't use it.
   # @param [Proc] block
   #
-  def self.build(obj=nil, gen_html=false, session={}, &block)
-    demeler = self.new(obj, session, &block)
+  def self.build(obj=nil, gen_html=false, usr=nil, &block)
+    demeler = self.new(obj, usr, &block)
     if gen_html then demeler.to_html else demeler.to_s end
   end
 
@@ -51,7 +51,7 @@ class Demeler
   # A note of warning: you'll get extra spaces in textareas if you use .to_html.
   #
   # @param [object] obj--a Sequel::Model object, or Hash object with an added 'errors' field.
-  # @param [Hash] session The session variable from the caller, although it can be anything because Demeler doesn't use it.
+  # @param [*] usr The usr variable from the caller; it can be anything because Demeler doesn't use it.
   # @param [Proc] block
   #
   # To use this without Sequel, you can use an object like this:
@@ -62,10 +62,10 @@ class Demeler
   #   end
   # end
   #
-  def initialize(obj=nil, session={}, &block)
+  def initialize(obj=nil, usr=nil, &block)
     raise ArgumentError.new("The object passed to Demeler must have an errors field containing a Hash") if obj && !defined?(obj.errors)
     @obj = obj
-    @session = session
+    @usr = usr
     clear
     instance_eval(&block) if block_given?
   end

data/notes

@@ -24,12 +24,20 @@ git config --list
 
 # To push up to GitHub
 git remote add origin https://github.com/mjwelchphd/demeler.git
+
+# UPDATE THE DEMELER GEM SRC
+# CHANGE VERSION AND DATE 
+# UPDATE CHANGELOG
+# UPDATE README
+# BUILD THE GEM
+# UPDATE 1.x to 1.y BELOW
+# COMMIT CHANGES IN GIT BEFORE PUSHING!
 git push -u origin master
 
 #----------------------------------------
 
 # To upload the gem to rubygems.org
-gem push demeler-1.0.1.gem
+gem push demeler-1.0.2.gem
 
 #----------------------------------------
 

data/spec/demeler.rb

@@ -84,7 +84,7 @@ describe "Simple Demeler with Session" do
 
   it "should pass through the session variable" do
     @d.clear
-    @d.out << session.inspect
+    @d.out << @d.usr.inspect
     @d.to_s.should.equal "{:id=>1}"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: demeler
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Michael J. Welch, Ph.D.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-10 00:00:00.000000000 Z
+date: 2017-06-12 00:00:00.000000000 Z
 dependencies: []
 description: This gem takes your ruby input, plus an object such as a Sequel::Model
   object, and generates HTML code. If the object has values, they're inserted into