data_reader 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff0a6030c8bc7b376c5752a0b9602371922f7116
-  data.tar.gz: 9b44d66c1bf1a9b5b695b7b9e3c0f1d7f7093483
+  metadata.gz: 8152cfa583503a6a29c82d1827b34f49010befe3
+  data.tar.gz: 4efc7ea01d4a6d1c6ab26d040da8b9674a6b6062
 SHA512:
-  metadata.gz: 572d60cac9bbaa7ad818fb106aba46c13571134e0ab7b1951dc474e42e1e290a79c7dbad610c8bbb142488bf0fb1a04e9aa194d320cb1fc16d80af5c8937866b
-  data.tar.gz: 73585bf1c77d4fc49907540d7625cc34ce3cdf06dd9888e7e5f0ac148059330a9e26d29e52e3f301ba73b8da6e85697d3c62e21a1ac014ae0ca7a82435a13b70
+  metadata.gz: 109adba9cd271069b31dc14dfa9cad47542c052ac69e4b1f1acdb993686400e8677a7efc51bf7fadc218687d1e886fb7c28d446c758cc6bc1c0acc43903ad622
+  data.tar.gz: d4eedbbd0d127e8db4e389fe73522d991d9645c85359add46a5f58d28338ffb5ef8d4c1228c3cf0a2e2fe1b8f2a9dc8b74700a5b9598cb221dcdae75e76bed8c

data/README.md

@@ -20,44 +20,107 @@ You can also install DataReader just as you would any other gem:
 
 ## Usage
 
-You can extend the DataReader to use it in another class or module.
+### Including DataReader
+
+You can include the DataReader in a class or module.
 
 ```ruby
-class DataBuilder
-  extend DataReader
+require "data_reader"
+
+class Testing
+  include DataReader
+end
+```
+
+DataReader does not set defaults for anything. It does hold a `data_path` that you set. It holds a `data_source` that is populated with the result of a file load.
+
+With the above class in place, you could do this:
+
+```ruby
+test = Testing.new
+
+test.data_path = 'data'
+
+puts test.data_path
+
+test.load 'default.yml'
+
+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.
+
+You could have specified the `data_path` as part of the class instead, like this:
+
+```ruby
+class Testing
+  include DataReader
+
+  def data_path
+    'data'
+  end
 end
 ```
 
-By extending the DataReader module you have three methods and two instance variables available to you. The three methods:
+Then you don't have to set the path specifically.
 
-* `data_path=`
-* `data_path`
-* `load`
+You can load multiple YAML files. The `load` method takes a list of comma separated names of files that are in that same directory.
 
-The instance variables:
+```ruby
+load 'users.yml, accounts.yml, billing.yml'
+```
+
+When loading in multiple files, the `data_source` will hold the contents of all the files in the list.
+
+### Extending DataReader
+
+You can also extend, rather than include, DataReader. This means you deal with the class rather than an instance of it. For example:
 
-* `@data_path`
-* `@data_source`
+```ruby
+require "data_reader"
 
-The `@data_path` instance variable will contain a reference to the location where the YAML file (or files) can be found. The `@data_source` instance variable will contain the contents of the YAML file after a call to `load`.
+class Testing
+  extend DataReader
+end
 
-### Multiple Data Files
+Testing.data_path = 'data'
 
-The `load` method can be used in two ways.
+puts Testing.data_path
 
-First, it can take the name of a file that is in the directory specified by the `@data_path` instance variable.
+Testing.load 'default.yml'
+
+puts Testing.data_source
+```
+
+Note that you can provide methods as you did in the include class, but make sure they are defined on `self`. For example:
 
 ```ruby
-load 'my_data.yml'
+class Testing
+  extend DataReader
+
+  def self.data_path
+    'data'
+  end
+end
 ```
 
-Second, it can also take a list of comma separated names of files that are in that same directory.
+### Default Path
+
+You can, at any time, set a data path. When you do, any calls to `load` will use that data path. However, you may want to make sure that a default data path is always available should a data path not have been specifically set. You can do that as follows:
 
 ```ruby
-load 'users.yml,accounts.yml,billing.yml'
+class Testing
+  include DataReader
+
+  def default_data_path
+    'data'
+  end
+end
 ```
 
-When loading in multiple files, the `@data_source` instance will hold the contents of all the files in the list.
+Remember to add a `self` to the method call if you are extending DataReader.
+
+Keep in mind that DataReader will always favor whatever it has stored in `data_path`. The `default_data_path` can be used for a fallback.
 
 ### Parameterizing Files
 
@@ -75,6 +138,8 @@ The support for ERB allows for custom calls. One that is included with DataReade
 <%= include_data("my_data.yml") %>
 ```
 
+If the above line was in a file called `default.yml` and you used the `load 'default.yml'` command, then, because of the call to `include_data` you would end up with the data from both files.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec:all` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`.
@@ -83,7 +148,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 Bug reports and pull requests are welcome on GitHub at [https://github.com/jnyman/data_reader](https://github.com/jnyman/data_reader). The testing ecosystem of Ruby is very large and this project is intended to be a welcoming arena for collaboration on yet another testing tool. As such, contributors are very much welcome but are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-To contribute to Decohere:
+To contribute to DataReader:
 
 1. [Fork the project](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
 2. Create your feature branch. (`git checkout -b my-new-feature`)
@@ -97,7 +162,7 @@ To contribute to Decohere:
 
 ## Credits
 
-This code is based upon the [YmlReader](https://github.com/cheezy/yml_reader) gem. I wanted to make a more generic version that may not be focused only on YAML files.
+This code is based upon the [YmlReader](https://github.com/cheezy/yml_reader) gem. I wanted to give myself room to make a more generic version that may not be focused only on YAML files. More importantly, I wanted to clean up the implementation and documentation a bit.
 
 ## License
 

data/lib/data_reader.rb

@@ -13,8 +13,14 @@ module DataReader
     nil
   end
 
+  def data_source
+    return @data_source if @data_source
+    nil
+  end
+
   def load(file_list)
     files = file_list.include?(',') ? file_list.split(',') : [file_list]
+    files = files.collect(&:strip)
     @data_source = files.inject({}) do |data, file|
       data.merge!(YAML.load(
                     ERB.new(File.read("#{data_path}/#{file}")).result(binding)

data/lib/data_reader/version.rb

@@ -1,3 +1,3 @@
 module DataReader
-  VERSION = "0.1.0".freeze
+  VERSION = "1.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_reader
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jeff Nyman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-16 00:00:00.000000000 Z
+date: 2016-10-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 0.1.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::)
+  \ DataReader 1.0.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::)
   (::) (::) (::) (::)\n  "
 rdoc_options: []
 require_paths: