data_reader 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 9a9082a5d52d807a6da3609a8503f49a0587f0dfb3eb64d94fbcd0446854ffb4
-  data.tar.gz: 3b31553d32f4e9af8fa8c5c1b6f658713598df9dda3e41f16126d16be7620933
+SHA1:
+  metadata.gz: 03ea2f3976b4b25953823cb6a13ef4df119c7267
+  data.tar.gz: 1254a6838cb0bbecd4736e7039db6541c75354d7
 SHA512:
-  metadata.gz: 3adcf3dbc00ff99725ebfc08a80fab31ce6daa49d373f3b60984f50d577300c2e81d56e95ad5b8e2819da3849e7c86bc08bff12aa10a21d57b3d44974c216879
-  data.tar.gz: 1a048a10a843ecc56c431e45a6b4681ceec7d72d1146805edd0e4cd477b9bb52625e27ebe64aa2491bce879a2e1e04686d98adef749ec7f2e03ba4f5c65b457d
+  metadata.gz: 2fd827774f7505783ff69cad7fa5a6eb5351c821cf33b77dfa629a1bfc722b8a45442f83dfbf11de5878553b19a3f1581fe0ae010bcb25527a8c2158cf6d099f
+  data.tar.gz: 5062f627830900e1cafd5b5c36020e0eb1d07f0f2bf782edf59cffd5c2582e3f3af3b94e684c515d739354e162b48cffcebd607a5990e4762c060174e6a8108b

data/README.md

@@ -64,26 +64,62 @@ project_dir\
   env\
     environments.yml
 
-  example-data-reader.rb
+  test-data-reader.rb
 ```
 
-All the code shown below would go in the `example-data-reader.rb` file.
+All the code shown below would go in the `test-data-reader.rb` file.
 
 With the above class in place and the above directory structure, you could do this:
 
 ```ruby
 test = Testing.new
 
+puts test.data_path
+puts test.data_source
+```
+
+This would print nothing for either of those values, showing that they have no default values as just stated. You could now do this:
+
+```ruby
 test.data_path = 'data'
 
 puts test.data_path
+```
+
+Here you are setting the `data_path` to a directory called `data`. The `puts` statement after that simply confirms that this was set. That will now set the data path for DataReader. Here the "data path" indicates where DataReader will look for data files. Thus you could load any file that is in that directory:
 
+```ruby
 test.load 'stars.yml'
+```
+
+Loading causes the data from the file to be put into the data source. This can be referenced directly by the `data_source` attribute.
+
 
+```ruby
 puts test.data_source
 ```
 
-Here you are setting the `data_path` to a directory called `data`. The `puts` statement after that simply confirms that this was set. You then call the `load` method for a YAML file that is in that directory. The `puts` call for the `data_source` will show you the contents of the YAML.
+The `puts` call for the `data_source` will show you the contents of the YAML.
+
+You could set the data source on the class instance if you wanted to:
+
+```ruby
+class Testing
+  include DataReader
+
+  def data
+    @data_source
+  end
+end
+```
+
+Now you can access the data via:
+
+```ruby
+puts test.data
+```
+
+The reason this might be useful is because the data source may change but this way you refer to it via one variable.
 
 ### Data Path on Class
 
@@ -99,42 +135,33 @@ class Testing
 end
 ```
 
-Then you don't have to set the path specifically on the instance.
-
-### Multiple Data Files
-
-You can load multiple YAML files. The `load` method takes a list of comma separated names of files that are in that same directory. So if you were to place all the above example YAML files in one directory, you could do this:
+Then you don't have to set the path specifically on the instance. That being said, you generally don't want to have both in place. Meaning either have the `data_path` defined on the test class or on the instance, not both. To show why this is problematic, consider this:
 
 ```ruby
-load 'config.yml, environments.yml, stars.yml'
-```
+class Testing
+  include DataReader
 
-When loading in multiple files, the `data_source` will hold the contents of all the files in the list.
+  def data_path
+    'data'
+  end
+end
 
-### Multiple Data Sources
+test = Testing.new
 
-You don't have to use the `data_source` value. For example, you could do this:
+test.data_path = 'combined'
 
-```ruby
-configs = app.load 'config.yml'
-envs = app.load 'environments.yml'
+test.load 'stars.yml'
 ```
 
-In this case, the appropriate data would be stored in each variable. Do note that `data_source` will always contain the last data read by the `load` method. So in the above case, `data_source` would contain the contents of `environments.yml` even if you never intended to use that variable.
-
-### Setting a Data Pata
-
-You can, at any time, set a data path. When you do, any calls to `load` will use that data path. Consider this example:
+Here I'm setting the `data_path` twice. This works because the data file `stars.yml` is in the `data`. But now try this:
 
 ```ruby
-app.data_path = 'config'
-configs = app.load 'config.yml'
-
-app.data_path = 'env'
-envs = app.load 'environments.yml'
+test.load 'config.yml'
 ```
 
-Do note that if you had defined a `data_path` method in your class, as shown above, that will always overridde a local instance setting as shown in the preceding code.
+That will fail. And that's because even though `config.yml` is in the `combined` directory, it's not in `data`. And that's what's being used here.
+
+The upshot is that if you define a `data_path` on the class, that's what will be used.
 
 ### Default Data Path
 
@@ -175,14 +202,83 @@ test.data_path = 'config'
 configs = test.load 'config.yml'
 puts test.data_source
 
-app.data_path = nil
+test.data_path = nil
 
-app.load 'stars.yml'
-puts app.data_source
+test.load 'stars.yml'
+puts test.data_source
 ```
 
 The second call to load the `stars.yml` file reverts to using the default data path.
 
+Just to show how this can fail, consider the following:
+
+```ruby
+class Testing
+  include DataReader
+
+  def default_data_path
+    'data'
+  end
+end
+
+test = Testing.new
+
+test.data_path = 'config'
+
+test.load 'stars.yml'
+```
+
+This would fail to load `stars.yml`. While `stars.yml` is in `data`, which is the default, you have set a specific data path here to `config`.
+
+The upshot is that a specific data path overrides the default.
+
+Note that named sections will currently cause a failure. So for example:
+
+```yaml
+users: &users
+  admin:
+  - username: admin
+  	password: admin
+```
+
+This would fail to load based on the `&users` part.
+
+### Multiple Data Files
+
+You can load multiple YAML files. The `load` method takes a list of comma separated names of files that are in that same directory. So if you were to place all the above example YAML files in one directory, you could do this:
+
+```ruby
+load 'config.yml, environments.yml, stars.yml'
+```
+
+When loading in multiple files, the `data_source` will hold the contents of all the files in the list.
+
+### Multiple Data Sources
+
+You don't have to use the `data_source` value. For example, you could do this:
+
+```ruby
+configs = app.load 'config.yml'
+envs = app.load 'environments.yml'
+```
+
+In this case, the appropriate data would be stored in each variable. Do note that `data_source` will always contain the last data read by the `load` method. So in the above case, `data_source` would contain the contents of `environments.yml` even if you never intended to use that variable.
+
+### Setting a Data Pata
+
+You can, at any time, set a data path. When you do, any calls to `load` will use that data path. Consider this example:
+
+```ruby
+app.data_path = 'config'
+configs = app.load 'config.yml'
+
+app.data_path = 'env'
+envs = app.load 'environments.yml'
+```
+
+Do note that if you had defined a `data_path` method in your class, as shown above, that will always overridde a local instance setting as shown in the preceding code.
+
+
 ### Parameterizing Data
 
 You can set environment variables in YAML files. To do this you have to use ERB, like this:

data/lib/data_reader/version.rb

@@ -1,3 +1,3 @@
 module DataReader
-  VERSION = "1.2.0".freeze
+  VERSION = "1.3.0".freeze
 end

data/lib/data_reader.rb

@@ -10,12 +10,7 @@ module DataReader
 
   def data_path
     return @data_path if @data_path
-
-    if respond_to? :default_data_path
-      @data_path = default_data_path
-      return default_data_path
-    end
-
+    return default_data_path if self.respond_to? :default_data_path
     nil
   end
 
@@ -36,7 +31,7 @@ module DataReader
   end
 
   def include_data(file)
-    filename = Pathname.new(file).absolute? ? file : "#{@data_path}/#{file}"
+    filename = Pathname.new(file).absolute? ? file : "#{data_path}/#{file}"
     ERB.new(IO.read(filename)).result(binding) if File.exist?(filename)
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_reader
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Jeff Nyman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2019-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,7 +107,7 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n
-  \ DataReader 1.2.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::)
+  \ DataReader 1.3.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::)
   (::) (::) (::) (::)\n  "
 rdoc_options: []
 require_paths:
@@ -123,7 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubyforge_project: 
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Provides a standard method for reading YAML data files