user-configurations 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ba776a1792dfcdcf240050bf38ecd316cec095f
+  data.tar.gz: bef0f44caee78ca5f273ecb2153c2b6caf6c927c
+SHA512:
+  metadata.gz: 552f316b1056bdea49bdbb009f5c54eaf4a4ebc827436d0a9fbdeefd54be0830b915141667bc4bb3189fe1c7a60a1d2dafbd64b3edfec91ba1b30ef351ce604d
+  data.tar.gz: 74916acf45fa9cabdcd0d8a795aa4bf1a21a2b59834f7df95ef4273aa5dd792807087a151629591462e9098269eaba47185875ba2f7b0f43f3cb493fba38878c

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,19 @@
+inherit_from: .rubocop_todo.yml
+
+Documentation:
+  Enabled: false
+
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - '**/*.gemspec'
+    - '**/Rakefile'
+  Exclude:
+    - 'vendor/**/*'
+    - 'db/**/*'
+    - 'bin/rails'
+    - 'bin/spring'
+    - 'bin/rake'
+  # By default, the rails cops are not run. Override in project or home
+  # directory .rubocop.yml files, or by giving the -R/--rails option.
+  RunRailsCops: true

data/.rubocop_todo.yml

@@ -0,0 +1,11 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-05-06 13:30:11 -0300 using RuboCop version 0.21.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+FileName:
+  Enabled: false

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+     DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                   Version 2, December 2004
+
+Copyright (C) 2013 Rafael Almeida <eusou@rafaelalmeida.net>
+
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -0,0 +1,29 @@
+# User::Configurations
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'user-configurations'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install user-configurations
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/stupie4ever/user-configurations/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/lib/user-configurations.rb

@@ -0,0 +1,8 @@
+require 'yaml'
+require 'delegate'
+
+require_relative 'user_configurations/version'
+require_relative 'user_configurations/configurations'
+
+module UserConfigurations
+end

data/lib/user_configurations/configuration.rb

@@ -0,0 +1,41 @@
+module UserConfigurations
+  class Configuration < SimpleDelegator
+    attr_accessor :project_name
+
+    def initialize(project_name)
+      @project_name = project_name
+      super global.merge(user).merge(environment)
+    end
+
+    def store(values)
+      File.write user_file, YAML.dump(user.merge(values))
+      merge! values
+    end
+
+    private
+
+    def global
+      load global_file
+    end
+
+    def user
+      load user_file
+    end
+
+    def user_file
+      File.expand_path File.join('~', ".#{project_name}")
+    end
+
+    def global_file
+      File.join('/', 'etc', project_name)
+    end
+
+    def load(file)
+      File.file?(file) ? YAML.load_file(file) : {}
+    end
+
+    def environment
+      ENV
+    end
+  end
+end

data/lib/user_configurations/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'user-configurations'
+
+RSpec.configure do |_|
+end

data/spec/user_configurations/configuration_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+module UserConfigurations
+  describe Configuration do
+    subject(:configuration) { Configuration.new project_name }
+
+    let(:project_name) { 'some-fake-project' }
+
+    let(:register_environment) { ENV[key] = 'environment' }
+    let(:register_user) { register user_file, key => 'user' }
+    let(:register_global) { register global_file, key => 'global' }
+
+    let(:user_file) { File.expand_path(File.join('~', ".#{ project_name }")) }
+    let(:global_file) { File.join('/', 'etc', project_name) }
+
+    let(:key) { 'KEY' }
+
+    before do
+      ENV.delete key
+      allow(File).to receive(:file?).with(user_file).and_return(false)
+      allow(File).to receive(:file?).with(global_file).and_return(false)
+    end
+
+    it 'fetches from environment variables first' do
+      register_environment
+      register_user
+      register_global
+      expect(configuration[key]).to eq('environment')
+    end
+
+    it "fetches from user configuration file in `$HOME/.project' second" do
+      register_user
+      register_global
+      expect(configuration[key]).to eq('user')
+    end
+
+    it "fetches from global configuration file in `/etc/project' third" do
+      register_global
+      expect(configuration[key]).to eq('global')
+    end
+
+    describe '#store' do
+      subject(:store) { configuration.store values }
+
+      let(:values) { { other_key => other_value } }
+      let(:other_key) { 'OTHER_KEY' }
+      let(:other_value) { 'other_value' }
+
+      it "stores values in user configuration file in `$HOME/.project'" do
+        expect(File).to receive(:write).with(user_file, YAML.dump(values))
+        store
+      end
+
+      it 'keeps the contents of user configuration file' do
+        register_user
+        expect(File).to receive(:write)
+          .with(user_file, YAML.dump({ key => 'user' }.merge(values)))
+        store
+      end
+
+      it 'fetches the new stored values' do
+        allow(File).to receive(:write)
+        store
+        expect(configuration.fetch other_key).to eq(other_value)
+      end
+    end
+
+    def register(file, contents)
+      allow(File).to receive(:file?).with(file).and_return(true)
+      allow(YAML).to receive(:load_file).with(file).and_return(contents)
+    end
+  end
+end

data/user-configurations.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'user_configurations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'user-configurations'
+  spec.version       = UserConfigurations::VERSION
+  spec.authors       = ['Rafael da Silva Almeida']
+  spec.email         = ['eusou@rafaelalmeida.net']
+  spec.summary       = %q(Configurations for a project)
+  spec.description   = %q(Configurations for a project, it will read from
+  env vars, local or global files)
+  spec.homepage      = 'http://github.com/stupied4ever/user-configurations'
+  spec.license       = 'wtfpl'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rspec', '~> 2.0'
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: user-configurations
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Rafael da Silva Almeida
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  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: |-
+  Configurations for a project, it will read from
+    env vars, local or global files
+email:
+- eusou@rafaelalmeida.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .rubocop_todo.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/user-configurations.rb
+- lib/user_configurations/configuration.rb
+- lib/user_configurations/version.rb
+- spec/spec_helper.rb
+- spec/user_configurations/configuration_spec.rb
+- user-configurations.gemspec
+homepage: http://github.com/stupied4ever/user-configurations
+licenses:
+- wtfpl
+metadata: {}
+post_install_message: 
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Configurations for a project
+test_files:
+- spec/spec_helper.rb
+- spec/user_configurations/configuration_spec.rb