user-configurations 0.0.1.pre → 0.0.1.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ba776a1792dfcdcf240050bf38ecd316cec095f
-  data.tar.gz: bef0f44caee78ca5f273ecb2153c2b6caf6c927c
+  metadata.gz: 46f79d9f56154dd4cffb06a5453a4f0aa3446342
+  data.tar.gz: 42f1dc3b659e0eb0df3d93e1eba69a002c28e6e3
 SHA512:
-  metadata.gz: 552f316b1056bdea49bdbb009f5c54eaf4a4ebc827436d0a9fbdeefd54be0830b915141667bc4bb3189fe1c7a60a1d2dafbd64b3edfec91ba1b30ef351ce604d
-  data.tar.gz: 74916acf45fa9cabdcd0d8a795aa4bf1a21a2b59834f7df95ef4273aa5dd792807087a151629591462e9098269eaba47185875ba2f7b0f43f3cb493fba38878c
+  metadata.gz: e25a58e254693aa04847a05642f6562c4262b5af85056677365909f853e4a4a15a718f44190f020741f8dd9b17ce3bcf8869612330865e18c4c22c015eef03fc
+  data.tar.gz: e81fadfe17999a182d3a38010a856b95b9e3582258760ade74585fe939f128c04418dfb7bf58691989681f33946d121d95702e4f0bd872bb048e3df45b8c0582

data/README.md

@@ -1,6 +1,5 @@
-# User::Configurations
-
-TODO: Write a gem description
+This gem will help you if you need to store and read user configurations on
+environments, global or local files.
 
 ## Installation
 
@@ -18,7 +17,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Reading
+
+```ruby
+configs = UserConfigurations::Configuration.new('project')
+configs['user_name']
+```
+
+That will give to you the value of that configuration on a ENV variable, local,
+or global variable (with that precedence).
+
+### Writing
+
+```ruby
+configs = UserConfigurations::Configuration.new('project')
+configs.store(user_name: 'stupied4ever')
+```
+
+Will store on a local file placed on ```~/.project``` a [YAML][yaml] file with
+```user_name```.
 
 ## Contributing
 
@@ -27,3 +44,5 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+[yaml]: https://en.wikipedia.org/wiki/YAML

data/lib/user-configurations.rb

@@ -2,7 +2,7 @@ require 'yaml'
 require 'delegate'
 
 require_relative 'user_configurations/version'
-require_relative 'user_configurations/configurations'
+require_relative 'user_configurations/configuration'
 
 module UserConfigurations
 end

data/lib/user_configurations/version.rb

@@ -1,3 +1,3 @@
 module UserConfigurations
-  VERSION = '0.0.1.pre'
+  VERSION = '0.0.1.pre1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: user-configurations
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
+  version: 0.0.1.pre1
 platform: ruby
 authors:
 - Rafael da Silva Almeida
@@ -14,14 +14,14 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 description: |-
@@ -33,10 +33,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .rubocop_todo.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -56,20 +56,21 @@ 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: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Configurations for a project
 test_files:
 - spec/spec_helper.rb
 - spec/user_configurations/configuration_spec.rb
+has_rdoc: