demeler 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acfebb387fbe7468614262a490e3a139cc473a93
-  data.tar.gz: ffc63a2408ee1fa55953579cd7a3a7a0b88c4ea2
+  metadata.gz: f45f975d6d264007855d0b65b8e99411c35ac272
+  data.tar.gz: 16a199c800c43a2673ef63694988ff5ca1a97329
 SHA512:
-  metadata.gz: 3faea11d3c64618169f3fa6f99d7adb928a2c0b1c454f8d26150adbca80c81cedcc5de25f580361efdc9318b8de8ea003d1e724e592e7e3c37995b73b9e3dd81
-  data.tar.gz: e3912710539a702240427b371c896f3f88fc9f778fd64713301faf2fe2223dca3fcbb4196a239da42bb58e9342e7880f6ba81ad1f6144734896ef2262b744b1d
+  metadata.gz: 057051d643c2387b0cf4234a5b221d9c73bb5b5e40750cb177bc5b4ebd9b7a213e90440e06df66d08b777ebff5101696a05230189a3fe91c3b633f2043d47360
+  data.tar.gz: af215ceb16abeb57bb96741b88d8b4784eeb2b33f93b4c3148555c691704d746a22fa6dd6d6dfa96a5d89afe659966c2dde9498d6c98bad7410c3d5c276640fc

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.0.3
+
+* Updated the README and Notes.
+
+
 # 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`.
@@ -13,7 +18,6 @@
 * 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

@@ -82,8 +82,58 @@ end
 puts d.to_html
 ```
 
+## Passing Variables into Demeler
+
+There are three variables you'll be interested in in Demeler.
+
+* `obj` The object, if any, that was passed as parameter 1 in `new` or `build`. I talk a little more about that one below.
+* `usr` The object, if any, that was passed as parameter 3 in `build` or parameter 2 in `new`. This object can be anything you need access to in the Demeler script. If you need to pass several objects, simply put them into an array or hash and pass that.
+* `out` This is an array where the intermediate results are held internally. To convert the array onto a String, use `to_s` or `to_html` if you created the Demeler object with `new`, and set parameter 2 to false or true if you used `build`.
+
+For example,
+
+```ruby
+countries = ['USA', 'Canada', 'France']
+Demeler.build(nil, true, countries) do
+  p usr.inspect
+end
+```
+
+ will generate:
+ 
+```html
+ <!-- begin generated output -->
+<p>["USA", "Canada", "France"]</p>
+<!-- end generated output -->
+```
+
+If you have more than one thing to pass into Demeler, put your things into an Array or Hash. For example, say you have two lists of countries and cities.
+
+```ruby
+countries = ['USA', 'Canada', 'France']
+cities = ['Los Angeles', 'Paris', 'Berlin']
+data = {:countries=>countries, :cities=>cities}
+Demeler.build(nil, true, data) do
+  p usr[:countries].inspect
+  p usr[:cities].inspect
+end
+```
+
+The output is
+
+```html
+<!-- begin generated output -->
+<p>["USA", "Canada", "France"]</p>
+<p>["Los Angeles", "Paris", "Berlin"]</p>
+<!-- end generated output -->
+```
+
+Note that the array is named `data` outside of Demeler, but once it's passed in through parameter 3 (usr) of `build`, inside Demeler it's name is `usr`.
+
 ## Fields from an object can be inserted automatically
 
+First, a word of warning: if you use variables other than those below, you script will crash. If your script crashes, don't blame Demeler first; look in your script for variables that shouldn't be there.
+
 You can automatically load the values from a Sequel::Model object, or you can define an object and use it in place of Sequel. To define an object, use a definition similar to this:
 
 ```ruby
@@ -98,15 +148,15 @@ You can automatically load the values from a Sequel::Model object, or you can de
 Your new object is just a Hash+, so you can assign it values like this:
 
 ```ruby
-  obj = Obj.new
-  obj[:username] = "michael"
-  obj[:password] = "my-password"
+  something = Obj.new
+  something[:username] = "michael"
+  something[:password] = "my-password"
 ```
 
 The object can now be used to fill `input` fields in a form:
 
 ```ruby
-  html = Demeler.build(obj,true) do
+  html = Demeler.build(something,true) do
     text :username
     password :password
   end
@@ -115,8 +165,6 @@ The object can now be used to fill `input` fields in a form:
 
 That code will automatically insert the values from `obj` for you.
 
-> _NOTE: When the first argument is a symbol, it is used as the name of the field._
-
 ```html
 <!-- begin generated output -->
 <input name="username" type="text" value="michael" />
@@ -124,6 +172,8 @@ That code will automatically insert the values from `obj` for you.
 <!-- end generated output -->
 ```
 
+> _NOTE: When the first argument is a symbol, it is used as the name of the field. Also, the form object is called `something` on the outside, but when we pass it through, it's name is `obj` on the inside._
+
 ### Demeler creates error messages, too
 
 You can put an error message into the object you created if your validation finds something wrong. Just insert a Hash element with the name of the element, and an array of lines, thusly:

data/lib/demeler/version.rb

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

data/notes

@@ -30,7 +30,7 @@ git remote add origin https://github.com/mjwelchphd/demeler.git
 # UPDATE CHANGELOG
 # UPDATE README
 # BUILD THE GEM
-# UPDATE 1.x to 1.y BELOW
+# UPDATE VERSION BELOW IN THE gem push COMMAND
 # COMMIT CHANGES IN GIT BEFORE PUSHING!
 git push -u origin master
 
@@ -39,6 +39,8 @@ git push -u origin master
 # To upload the gem to rubygems.org
 gem push demeler-1.0.2.gem
 
+sudo gem install demeler
+
 #----------------------------------------
 
 # To run 'irb' for testing

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: demeler
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Michael J. Welch, Ph.D.