data_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7a104b8ca0cab66dd4af88df664789da0f29738
+  data.tar.gz: 70896d546ce15ebd607cee7110171845ff3690bc
+SHA512:
+  metadata.gz: f6613cff274038ce424c85841d690ae60688f77e365de5fccb0db8f266bb6a705e5caa8895b7afa61d6934e86f7a9a20e394e6dfd3a338fb29db60c5e40d3a34
+  data.tar.gz: 57effa8bcfc6c8d852821440f3abc2f93ba641ebc4a08517bda1a0dbda30d2b1e528e93ec9e5bc9df2e0e59db3b896d170e8126459f54102250126766c08c734

data/.gitignore

@@ -0,0 +1,40 @@
+# Ruby-Specific
+
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+
+# Ouput-Specific
+
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.log
+*.tmp
+*.swp
+*.bak
+
+# IDE-Specific
+
+.idea
+.settings
+.project
+.classpath
+*.iws
+
+# Windows-Specific
+
+Thumbs.db
+
+# Mac OS-Specific
+
+*.DS_Store
+._*
+
+# Linux-Specific
+
+.directory
+.Trash-*

data/.hound.yml

@@ -0,0 +1,62 @@
+AllCops:
+  Exclude:
+    - data_builder.gemspec
+    - test/*.rb
+    - spec/**/*
+
+# Removing need for frozen string literal comment.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Removing the preference for string single quotes.
+Style/StringLiterals:
+  Enabled: false
+
+# Missing top-level module documentation comment.
+Style/Documentation:
+  Enabled: false
+
+# Prefer reduce over inject.
+Style/CollectionMethods:
+  PreferredMethods:
+    reduce: 'inject'
+
+# Use each_with_object instead of inject.
+Style/EachWithObject:
+  Enabled: false
+
+# Prefer fail over raise.
+Style/SignalException:
+  Enabled: false
+
+# This never works for validations.
+Style/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+# Align multi-line params with previous line.
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+# Indent `when` clause one step from `case`.
+Style/CaseIndentation:
+  IndentOneStep: true
+
+# Don't force bad var names for reduce/inject loops.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# For method chains, keep the dot with the method name.
+Style/DotPosition:
+  EnforcedStyle: leading
+
+# Stop nesting so hard.
+Metrics/BlockNesting:
+  Max: 2
+
+# Encourage short methods.
+Metrics/MethodLength:
+  Max: 10
+
+# Encourage fewer parameters.
+Metrics/ParameterLists:
+  Max: 4

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - .hound.yml

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jeffnyman@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in data_builder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jeff Nyman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,166 @@
+# DataBuilder
+
+[![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/jnyman/data_builder/blob/master/LICENSE.txt)
+
+[![Dependency Status](https://gemnasium.com/jnyman/data_builder.png)](https://gemnasium.com/jnyman/data_builder)
+
+The goal of DataBuilder is to apply an expressive means of constructing a data set based on information stored in YAML files.
+
+## Installation
+
+To get the latest stable release, add this line to your application's Gemfile:
+
+```ruby
+gem 'data_builder'
+```
+
+And then include it in your bundle:
+
+    $ bundle
+
+You can also install DataBuilder just as you would any other gem:
+
+    $ gem install data_builder
+
+## Usage
+
+DataBuilder is using my [DataReader gem](https://github.com/jnyman/data_reader) to provide base-level functionality. Unlike DataReader, DataBuilder will assume some defaults. For example, you could do something as simple as this:
+
+```ruby
+require "data_builder"
+
+data = DataBuilder.load 'default.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:
+
+```ruby
+require "data_builder"
+
+DataBuilder.data_path = 'config/data'
+data = DataBuilder.load 'default.yml'
+
+puts data
+```
+
+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`.
+
+After setting the directory you must load a file. This can be accomplished by calling the `load` method.
+
+```ruby
+DataBuilder.load 'default.yml'
+```
+
+However, these approaches are really just using DataBuilder as an overlay for DataReader.
+
+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.
+
+The most common way to use this is to include or extend the DataBuilder module. Let's say that you have a `data` directory and in that directory you have a file called `default.yml`. The YAML file has the following contents:
+
+```yaml
+alpha centauri:
+  warpFactor: 1
+  velocity: 2
+  distance: 4.3
+
+epsilon eridani:
+  warpFactor: 1
+  velocity: 2
+  distance: 10.5
+```
+
+Now let's use DataBuilder to get the information from it.
+
+### Extending DataBuilder
+
+```ruby
+class Testing
+  extend DataBuilder
+end
+
+data = Testing.data_about('alpha centauri')
+```
+
+### Including DataBuilder
+
+```ruby
+class Testing
+  include DataBuilder
+end
+
+testing = Testing.new
+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 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:
+
+```ruby
+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`.
+ 
+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:
+
+```
+class Testing
+  include DataBuilder
+end
+
+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".
+
+### Aliases
+
+Given the examples, you can see that `data_about` was chosen as the method name to make what's occurring a bit more expressive. You can use the following aliases for `data_about`:
+
+* `data_from`
+* `data_for`
+* `using_data_for`
+* `using_data_from`
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/jnyman/data_builder](https://github.com/jnyman/data_builder). 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 DataBuilder:
+
+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`)
+3. Commit your changes. (`git commit -am 'new feature'`)
+4. Push the branch. (`git push origin my-new-feature`)
+5. Create a new [pull request](https://help.github.com/articles/using-pull-requests).
+
+## Author
+
+* [Jeff Nyman](http://testerstories.com)
+
+## Credits
+
+This code is loosely based upon the [DataMagic](https://github.com/cheezy/data_magic) gem. I created a new version largely to avoid the name "magic", which I don't think any tool should be promoting. I'm also cleaning up the code and documentation.
+
+## License
+
+DataReader is distributed under the [MIT](http://www.opensource.org/licenses/MIT) license.
+See the [LICENSE](https://github.com/jnyman/data_builder/blob/master/LICENSE.txt) file for details.

data/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rdoc/task"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
+
+RuboCop::RakeTask.new
+
+namespace :spec do
+  desc 'Clean all generated reports'
+  task :clean do
+    system('rm -rf spec/reports')
+  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)
+
+    config.rspec_opts = options
+  end
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.main = 'README.md'
+  rdoc.title = "DataBuilder #{DataBuilder::VERSION}"
+  rdoc.rdoc_files.include('README*', 'lib/**/*.rb')
+end
+
+task default: ['spec:all', :rubocop]

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "data_builder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/data_builder.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'data_builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "data_builder"
+  spec.version       = DataBuilder::VERSION
+  spec.authors       = ["Jeff Nyman"]
+  spec.email         = ["jeffnyman@gmail.com"]
+
+  spec.summary       = %q{Provides expressive data set handling from YAML files.}
+  spec.description   = %q{Provides expressive data set handling from YAML files.}
+  spec.homepage      = "https://github.com/jnyman/data_builder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "data_reader"
+
+  spec.post_install_message = %{
+(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+  DataBuilder #{DataBuilder::VERSION} has been installed.
+(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+  }
+end

data/lib/data_builder/version.rb

@@ -0,0 +1,3 @@
+module DataBuilder
+  VERSION = "0.1.0".freeze
+end

data/lib/data_builder.rb

@@ -0,0 +1,41 @@
+require "data_builder/version"
+
+require "data_reader"
+
+module DataBuilder
+  extend DataReader
+
+  class << self
+    attr_accessor :data_source
+
+    def default_data_path
+      'data'
+    end
+  end
+
+  def data_about(key, specified = {})
+    if key.is_a?(String) && key.match(%r{/})
+      file, record = key.split('/')
+      DataBuilder.load("#{file}.yml")
+    else
+      record = key.to_s
+      DataBuilder.load(builder_source) unless DataBuilder.data_source
+    end
+
+    data = DataBuilder.data_source[record]
+    raise ArgumentError, "Undefined key for data: #{key}" unless data
+
+    data.merge(specified).clone
+  end
+
+  alias data_from data_about
+  alias data_for data_about
+  alias using_data_for data_about
+  alias using_data_from data_about
+
+  private
+
+  def builder_source
+    ENV['DATA_BUILDER_SOURCE'] ? ENV['DATA_BUILDER_SOURCE'] : 'default.yml'
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: data_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Nyman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: data_reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides expressive data set handling from YAML files.
+email:
+- jeffnyman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data_builder.gemspec
+- lib/data_builder.rb
+- lib/data_builder/version.rb
+homepage: https://github.com/jnyman/data_builder
+licenses:
+- MIT
+metadata: {}
+post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n
+  \ DataBuilder 0.1.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::)
+  (::) (::) (::) (::)\n  "
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Provides expressive data set handling from YAML files.
+test_files: []