yaml_smoosher 0.1.3 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +7 -9
  3. data/lib/yaml_smoosher.rb +1 -1
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a18c541f11dc50a7e734629a3814f482b9bbb8760707873a7b2095ac7703e1c7
4
- data.tar.gz: dcac8644d1d76509bbcc93322708d8e8d63ec084ebf947474da064ec8cdabcc3
3
+ metadata.gz: d9bb77b047a15d02544c80f5b662d0e1f6bfc48915d733645e7bd66b902f1e89
4
+ data.tar.gz: 2007135028b4c0f5d99d34f2f4b02b2505695c19fe0bdae7a281a60f30b09ff6
5
5
  SHA512:
6
- metadata.gz: e9a8b936678d2ff667c0cd1d7830904072b36e6fdb998fd26a1070f1a0587f893e3e4cb74b14ab8e346ba6ecfdf878f7cb674cfab2ab0ecb71c71479093bb33b
7
- data.tar.gz: 3206afae7101b9e0b7871ddf9cec031ba3f32f992669810859df16c8b7ab5a55ee78aa8e80277526afcdfa8a483284a602318a2ca6028a8ccd6d2fba9867bc6f
6
+ metadata.gz: de60b5e9a41466a0773b8994153e54f67d95bc298578fc622543d966172ca47785dacfb3cdfd72ebbc6731371b07029969ee3c3925f50aad2d1d47845a774f0e
7
+ data.tar.gz: a3e0fbcff70c1eea8dd30657de3402793bff9b10c0d74d1d27f0f4c96fbaa2478da915c81e1d3f4c783a2458337955612f9daf7f6665feef418da9c4e792b09e
data/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # YamlSmoosher
2
2
 
3
- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yaml_smoosher`. To experiment with that code, run `bin/console` for an interactive prompt.
4
-
5
- TODO: Delete this and the text above, and describe your gem
3
+ Gem to read all .yml and .yml.erb files in a directory and smoosh them into a single hash (in a vaguely similar fashion
4
+ to Rails i18n. Reads all the files and merges the parsed hashed with the
5
+ [deep_merge](https://github.com/danielsdeleo/deep_merge) gem.
6
6
 
7
7
  ## Installation
8
8
 
@@ -22,11 +22,13 @@ Or install it yourself as:
22
22
 
23
23
  ## Usage
24
24
 
25
- TODO: Write usage instructions here
25
+ Point `YamlSmoosher.call` to a directory of .yml and .yml.erb files.
26
+
27
+ `hash = YamlSmoosher.call(File.join(Rails.application.root, "some_folder"))`
26
28
 
27
29
  ## Development
28
30
 
29
- After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
31
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
30
32
 
31
33
  To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
34
 
@@ -38,7 +40,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
38
40
  ## License
39
41
 
40
42
  The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
41
-
42
- ## Code of Conduct
43
-
44
- Everyone interacting in the YamlSmoosher project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/yaml_smoosher/blob/master/CODE_OF_CONDUCT.md).
@@ -3,7 +3,7 @@ require "yaml"
3
3
  require "erb"
4
4
 
5
5
  class YamlSmoosher
6
- VERSION = "0.1.3"
6
+ VERSION = "1.0.0"
7
7
 
8
8
  class << self
9
9
  def call(args)
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: yaml_smoosher
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.3
4
+ version: 1.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Nick Bolt