data_builder 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24aa0d4e8e24c2d43cb2b24e4cf02cf87f5968bd
-  data.tar.gz: 03a81f95a587216a1407342171b0721a4cb93191
+  metadata.gz: 5ffa6367098c65adf86a4c45a05c9a3cf68d9ea8
+  data.tar.gz: 6714fbdb50f5342f6706947b1d6e581507bbbb86
 SHA512:
-  metadata.gz: a841011ab6f7c2fc74f1597845d3ecd60c7e4f909cd96eaa73ea025edb46d3fe8bf76d86eb289434aef72e16aaededaf59afe609f82b5d9d4635b745e0d099e3
-  data.tar.gz: c8c972df9e1544f92b48539db7595223ce45e7ae76ee8b382d1841e4244a2e2daaecf983fa37b602026df7d61264810f3d90d19b8fb3ed5add2663b46f49080c
+  metadata.gz: dd34e50ba54ad2d37605e66b84529e5f99bdf95141bbdaec8036707c9c0927ec8d848db48311d8011d0fb7d48ec2bdf8802489039666e305c198442b00ad600c
+  data.tar.gz: 30fa6c54b64e20bfc29fa356e2af558efd812a1bda3564325c61d8218d91153159157367a28b2e5c72c26182f395a53ca66732f5fd9a6035371c17a5d83f7dc4

data/.hound.yml

@@ -30,15 +30,15 @@ Style/SignalException:
   Enabled: false
 
 # This never works for validations.
-Style/AlignHash:
+Layout/AlignHash:
   EnforcedLastArgumentHashStyle: ignore_implicit
 
 # Align multi-line params with previous line.
-Style/AlignParameters:
+Layout/AlignParameters:
   EnforcedStyle: with_fixed_indentation
 
 # Indent `when` clause one step from `case`.
-Style/CaseIndentation:
+Layout/CaseIndentation:
   IndentOneStep: true
 
 # Don't force bad var names for reduce/inject loops.
@@ -46,7 +46,7 @@ Style/SingleLineBlockParams:
   Enabled: false
 
 # For method chains, keep the dot with the method name.
-Style/DotPosition:
+Layout/DotPosition:
   EnforcedStyle: leading
 
 # Stop nesting so hard.

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/data_builder.svg)](http://badge.fury.io/rb/data_builder)
 [![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jeffnyman/data_builder/blob/master/LICENSE.txt)
 
-[![Dependency Status](https://gemnasium.com/jnyman/data_builder.png)](https://gemnasium.com/jnyman/data_builder)
+[![Dependency Status](https://gemnasium.com/jeffnyman/data_builder.png)](https://gemnasium.com/jeffnyman/data_builder)
 
 The goal of DataBuilder is to apply an expressive means of constructing a data set based on information stored in YAML files.
 
@@ -25,25 +25,48 @@ You can also install DataBuilder just as you would any other gem:
 
 ## Usage
 
-DataBuilder is using my [DataReader gem](https://github.com/jeffnyman/data_reader) to provide base-level functionality. Unlike DataReader, DataBuilder will assume some defaults. For example, you could do something as simple as this:
+DataBuilder is using my [DataReader gem](https://github.com/jeffnyman/data_reader) to provide base-level functionality. Unlike DataReader, DataBuilder will assume some defaults.
+
+### Loading with Default Path
+
+Consider the following file and directory setup:
+
+```
+project_dir\
+  config\
+    config.yml
+
+  data\
+    stars.yml
+
+  env\
+    environments.yml
+
+  example-data-builder.rb
+```
+
+All the code shown below would go in the `example-data-builder` file.
+
+With the above class in place and the above directory structure, you could do something as simple as this:
 
 ```ruby
 require "data_builder"
 
-data = DataBuilder.load 'default.yml'
+data = DataBuilder.load 'stars.yml'
 
 puts data
 ```
 
-Here I'm relying on the fact that DataBuilder applies a default directory of `data`. I then use the `load` method of DataReader to call up a file in that directory. I could set my own data path with DataBuilder as such:
+Here I'm relying on the fact that DataBuilder applies a default directory of `data`. I then use the `load` method of DataReader to call up a file in that directory.
+
+### Loading with Specified Path
+
+You can set a specific data path with DataBuilder as such:
 
 ```ruby
 require "data_builder"
 
-DataBuilder.data_path = 'config/data'
-data = DataBuilder.load 'default.yml'
-
-puts data
+DataBuilder.data_path = 'env'
 ```
 
 Here you can inform DataBuilder where it can find the data files using `data_path`. As you've seen, if you don't specify a directory then DataBuilder will default to using a directory named `data`.
@@ -51,10 +74,16 @@ Here you can inform DataBuilder where it can find the data files using `data_pat
 After setting the directory you must load a file. This can be accomplished by calling the `load` method.
 
 ```ruby
-DataBuilder.load 'default.yml'
+data = DataBuilder.load 'environments.yml'
+
+puts data
 ```
 
-However, these approaches are really just using DataBuilder as an overlay for DataReader.
+Here the `data` variable would contain the contents of the `environments.yml` file.
+
+However, everything said so far is really just using DataBuilder as an overlay for DataReader.
+
+### Data About
 
 Where DataBuilder steps in is when you want to use the data. DataBuilder provides a `data_about` method that will return the data for a specific key from any data files that have been loaded.
 
@@ -72,9 +101,9 @@ epsilon eridani:
   distance: 10.5
 ```
 
-Now let's use DataBuilder to get the information from it.
+Now let's use DataBuilder to get the information from it. You can extend or include DataBuilder as part of another class.
 
-### Extending DataBuilder
+#### Extending DataBuilder
 
 ```ruby
 class Testing
@@ -84,7 +113,7 @@ end
 data = Testing.data_about('alpha centauri')
 ```
 
-### Including DataBuilder
+#### Including DataBuilder
 
 ```ruby
 class Testing
@@ -97,9 +126,9 @@ data = testing.data_about('alpha centauri')
 
 ### The Data Key
 
-In both cases of extending or including, I'm using a variable to store the results of the call. Those results will be the data pulled from the `default.yml` file. Of note, however, is that all that will be pulled is the data from the "alpha centauri" key because that is what you specified in the call to `data_about`.
+In both cases of extending or including, I'm using a variable to store the results of the call. Those results will be the data pulled from the `default.yml` file. Of note, however, is all that will be pulled is the data from the "alpha centauri" key because that is what you specified in the call to `data_about`.
 
-In these examples, I'm using a string because the value "alpha centauri" has a space in it. However, if that was not the case -- if the key were, say, alpha_centauri -- then you could use a symbol instead, like this:
+Those examples show `data_about` being passed a string and the reason for that is because the value "alpha centauri" has a space in it. However, if that was not the case -- if the key were, say, "alpha_centauri" -- then you could use a symbol instead, like this:
 
 ```ruby
 data = testing.data_about(:alpha_centauri)
@@ -107,15 +136,15 @@ data = testing.data_about(:alpha_centauri)
 
 ### Default Files
 
-You might wonder how DataBuilder knew to look for `default.yml` since I didn't use a `load` method in these examples. If you do not specify a filename the logic will attempt to use a file named `default.yml` in the data path you have specified or in the default path of `data`.
+You might wonder how DataBuilder knew to look for `default.yml` since I didn't use a `load` method in these examples. If you do not specify a filename the logic will attempt to use a file named `default.yml` in the specific data path you have specified or in the default path of `data`.
  
-Another option is that you can set an environment variable called DATA_BUILDER_SOURCE. When this variable exists and is set, the value it is set to will be used instead of the `default.yml` file. Keep in mind that the "data source" here refers to the file, not the keys within a file.
+Another option is that you can set an environment variable called `DATA_BUILDER_SOURCE`. When this variable exists and is set, the value it is set to will be used instead of the `default.yml` file. Keep in mind that the "data source" here refers to the file, not the keys within a file.
 
 ### Namespaced Data
 
 To organize your data into a rough equivalent of namespaces, and to load that data accordingly, you can do something like this:
 
-```
+```ruby
 class Testing
   include DataBuilder
 end
@@ -125,7 +154,7 @@ testing = Testing.new
 data = testing.data_about('stars/epsilon eridani')
 ```
 
-When DataBuilder sees this kind of construct, it will take the first part (before the /) as a filename and the second part as the key to look up in that file. So the above command would look for a file called `stars.yml` in the data path provided and then grab the data from the key entry labeled "epislon eridani".
+When DataBuilder sees this kind of construct, it will take the first part (before the /) as a filename and the second part as the key to look up in that file. So the above command would look for a file called `stars.yml` in the data path provided (in this case, the default of `data`) and then grab the data from the key entry labeled "epislon eridani".
 
 ### Aliases
 
@@ -136,6 +165,8 @@ Given the examples, you can see that `data_about` was chosen as the method name
 * `using_data_for`
 * `using_data_from`
 
+The reason for these aliases is, again, to make the logic expressive about its intent. This is particularly nice if you fit DataBuilder in with the context of a fluent API.
+
 ## 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`.

data/Rakefile

@@ -13,9 +13,9 @@ namespace :spec do
   end
 
   RSpec::Core::RakeTask.new(all: :clean) do |config|
-    options  = %w(--color)
-    options += %w(--format documentation)
-    options += %w(--format html --out spec/reports/unit-test-report.html)
+    options  = %w[--color]
+    options += %w[--format documentation]
+    options += %w[--format html --out spec/reports/unit-test-report.html]
 
     config.rspec_opts = options
   end

data/data/account.yml

@@ -0,0 +1,3 @@
+test:
+  name: TesterStories
+  owner: Jeff Nyman

data/data/default.yml

@@ -0,0 +1,3 @@
+test:
+  data_01: xyzzy
+  data_02: zzyzx

data/lib/data_builder.rb

@@ -11,6 +11,13 @@ module DataBuilder
     def default_data_path
       'data'
     end
+
+    def data_files_for(scenario)
+      tags = scenario.send(scenario.respond_to?(:tags) ? :tags : :source_tags)
+      tags.map(&:name).select { |t| t =~ /@databuilder_/ }.map do |t|
+        t.gsub('@databuilder_', '').to_sym
+      end
+    end
   end
 
   def data_about(key, specified = {})
@@ -33,6 +40,14 @@ module DataBuilder
   alias using_data_for data_about
   alias using_data_from data_about
 
+  def self.use_in_scenario(scenario, data_location = DataBuilder.data_path)
+    original_data_path = DataBuilder.data_path
+    DataBuilder.data_path = data_location
+    data_files = data_files_for(scenario)
+    DataBuilder.load("#{data_files.last}.yml") if data_files.count > 0
+    DataBuilder.data_path = original_data_path
+  end
+
   private
 
   def builder_source

data/lib/data_builder/version.rb

@@ -1,3 +1,3 @@
 module DataBuilder
-  VERSION = "0.2.0".freeze
+  VERSION = "1.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_builder
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jeff Nyman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-28 00:00:00.000000000 Z
+date: 2017-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,6 +113,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- data/account.yml
+- data/default.yml
 - data_builder.gemspec
 - lib/data_builder.rb
 - lib/data_builder/version.rb
@@ -121,7 +123,7 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n
-  \ DataBuilder 0.2.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::)
+  \ DataBuilder 1.0.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::)
   (::) (::) (::) (::)\n  "
 rdoc_options: []
 require_paths:
@@ -138,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Provides expressive data set handling from YAML files.