quandl-config 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36b55fd81a33c3118fdd834c7039dbdbc329188c
+  data.tar.gz: 989c8386206043b99dfb8d071818fcc12181b149
+SHA512:
+  metadata.gz: c953ae47a416c6fd2a8851b26d397877f0e7d8295ca0a21f1961060cc2f12e0c7abe74147333d9e0ce8a07f15456d8e599ce33160790546734df9da5c41b27a8
+  data.tar.gz: 9cf64d6da20a947364eb18ba6808d643d72bf781842318f5587155d1e4701a70d8649050722dcdd1de7fdcf4f8448224e96e75b27c587f9ad8493e77f4222811

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/.rubocop.yml

@@ -0,0 +1,6 @@
+LineLength:
+  Max: 150
+Documentation:
+  Enabled: false
+FileName:
+  Enabled: false

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Najwa Azer
+
+MIT License
+
+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,65 @@
+# Quandl::Config
+
+This gem allows you to quickly convert YML files into a `Config` object where the attributes can be accessed using dot, hash symbol or hash string notation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'quandl-config'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quandl-config
+
+## Usage
+
+1. Create a `yml` file with the same file name as your class. For example:
+```
+class: A::B::C
+file name: config/a/b/c.yml
+```
+
+2. Extend the Quandl::Configurable class. This adds a configuration class method.
+```ruby
+class A::B::C
+  extend Quandl::Configurable
+end
+```
+
+```ruby
+pry
+pry> A::B::C.configuration
+=> #<Quandl::Config language="spanish", hello="hola">
+```
+
+### What if my yml file name doesn't match the class name?
+
+```ruby
+class A::B::Special
+  extend Quandl::Configurable
+  def self.file_name
+    'database_zip_uploader'
+  end
+end
+```
+
+### What if I want configuration to be an instance method?
+
+```ruby
+class A::B::C
+  include Quandl::Configurable
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/quandl-config/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/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task default: :spec

data/lib/quandl/config.rb

@@ -0,0 +1,24 @@
+require 'ostruct'
+require 'yaml'
+
+module Quandl
+  class Config < ::OpenStruct
+    VERSION = '0.0.1'
+
+    def initialize(file_name)
+      raw_config = File.read(::Rails.root.join('config', "#{file_name}.yml"))
+      erb_config = ERB.new(raw_config).result
+      config = YAML.load(erb_config)[Rails.env]
+
+      super(config)
+    end
+
+    def configurable_attributes
+      setters_and_getters = methods - self.class.instance_methods
+      getters = setters_and_getters.reject { |method| method =~ /=$/ }
+      getters
+    end
+  end
+end
+
+require 'quandl/configurable'

data/lib/quandl/configurable.rb

@@ -0,0 +1,15 @@
+require 'active_support/inflector'
+
+module Quandl
+  module Configurable
+    def configuration
+      @configuration ||= Config.new(file_name)
+    end
+
+    private
+
+    def file_name
+      defined?(name) ? name.underscore : self.class.name.underscore
+    end
+  end
+end

data/quandl-config.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quandl/config'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'quandl-config'
+  spec.version       = Quandl::Config::VERSION
+  spec.authors       = ['Najwa Azer']
+  spec.email         = ['najwa.azer@gmail.com']
+  spec.summary       = 'Openstruct-based per-class configuration.'
+  spec.description   = 'Openstruct-based per-class configuration.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  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 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-nc'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-remote'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_runtime_dependency 'activesupport'
+end

data/spec/fixtures/config/fake.yml

@@ -0,0 +1,41 @@
+defaults: &defaults
+  webhook_url: https://hooks.slack.com/services/fake/fake/fake
+  notifiers: &default_subclasses
+    asset_management:
+      channel: '#releases'
+      username: Next Asset Deployer
+      icon_emoji: airplane
+    stripe:
+      channel: '#stripe-testing'
+      username: stripe
+    ci:
+      channel: <%= ENV.fetch('SLACK_CHANNEL', "'#development'") %>
+
+development:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+jenkins:
+  <<: *defaults
+
+vagrant:
+  <<: *defaults
+
+vagrant_test:
+  <<: *defaults
+
+vagrant_staging:
+  <<: *defaults
+
+production:
+  <<: *defaults
+  subclasses:
+    <<: *default_subclasses
+    stripe:
+      channel: '#stripe-events'
+      username: stripe

data/spec/fixtures/dummy_app.rb

@@ -0,0 +1,11 @@
+Rails = Class.new do
+  require "#{File.dirname(__FILE__)}/dummy_app/fake"
+
+  def self.root
+    Pathname.new(File.dirname(__FILE__))
+  end
+
+  def self.env
+    'development'
+  end
+end

data/spec/fixtures/dummy_app/fake.rb

@@ -0,0 +1,2 @@
+class Fake
+end

data/spec/quandl/quandl-config_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Quandl::Config do
+  describe '.initialize' do
+    it 'generates a Config class, evaluating ERB' do
+      configuration = Quandl::Config.new('fake')
+
+      expect(configuration['notifiers']['ci']['channel']).to eq('#development')
+    end
+  end
+
+  describe '#configurable_attributes' do
+    it 'provides a list of configurable attributes' do
+      configuration = Quandl::Config.new('fake')
+
+      expect(configuration.configurable_attributes).to eq([:webhook_url, :notifiers])
+    end
+  end
+end

data/spec/quandl/quandl-configurable_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Quandl::Configurable do
+  context 'when extending' do
+    it 'adds a configuration class method' do
+      Fake.extend(Quandl::Configurable)
+      expect(Fake.configuration).to be_kind_of(Quandl::Config)
+    end
+  end
+
+  context 'when including' do
+    it 'adds a configuration instance method' do
+      Fake.include(Quandl::Configurable)
+      expect(Fake.new.configuration).to be_kind_of(Quandl::Config)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'pry'
+require 'quandl/config'
+require 'fixtures/dummy_app'

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: quandl-config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Najwa Azer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: rspec-nc
+  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: guard
+  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: guard-rspec
+  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: pry-remote
+  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-nav
+  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: activesupport
+  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: Openstruct-based per-class configuration.
+email:
+- najwa.azer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/quandl/config.rb
+- lib/quandl/configurable.rb
+- quandl-config.gemspec
+- spec/fixtures/config/fake.yml
+- spec/fixtures/dummy_app.rb
+- spec/fixtures/dummy_app/fake.rb
+- spec/quandl/quandl-config_spec.rb
+- spec/quandl/quandl-configurable_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Openstruct-based per-class configuration.
+test_files:
+- spec/fixtures/config/fake.yml
+- spec/fixtures/dummy_app.rb
+- spec/fixtures/dummy_app/fake.rb
+- spec/quandl/quandl-config_spec.rb
+- spec/quandl/quandl-configurable_spec.rb
+- spec/spec_helper.rb