config_this 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 104987bb4424859bdc6f284cc86c3c00d7e664cb1d1ecef53bfc77ef82cabd61
+  data.tar.gz: d1fb58a6172f84d6332aefba72a374789fcc9bf9cbee8a016d637ab0b02beb31
+SHA512:
+  metadata.gz: 57222320ce79d442fdf26be91e5e0960dd85027836c0d7ae0baef50c698b48b6708b4fecbdcfd55d580a39cc3c3f554ed35f18b68cd88d4751b909a0fb29e8e5
+  data.tar.gz: 1ec9bbdd863ced085a4f877ee248a48ca59c976454d3b8796e20b3cc2e3110667ec2f3ea71d45d1e576d3966e21e3e219e6bedbef88d23f2889f10c76c7e5b65

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.0.pre.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Edmundo Sanchez
+
+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,96 @@
+# Config
+
+Have you ever wondered where is the right way to store sensitive information like passwords for your ruby scripts and gems?
+
+I have, doing some research I found a few ways to create a class that will help set  configuration object for your script, but I would have to write it for every script I write, so I created this gem.
+
+With **Config** you can load your configuration parameters from a YAML or json file, a block or a hash.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'config'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install config
+
+## Usage
+
+The Config Module is the main interface for this gem, as you know you can not instantiate a Module so be careful with your values
+
+### Get the Configuration object
+
+This will get the latest object you created.
+``` ruby
+Config.get
+ => #<Config::Configuration:0x000055d538ef2dc0>
+```
+
+### Setting the configuration Object
+
+If you plan on having only one configuration object you don't need to assign it, it will always return
+
+``` ruby
+Config.set(id:42, name: "Arthur Dent")
+ => #<Config::Configuration:0x000055d538f3c9c0 @id=42, @name="Arthur Dent">
+```
+
+If you do plan to have multiple configurations, handle them properly
+
+``` ruby
+Config.set(id:42, name: "Arthur Dent")
+ => #<Config::Configuration:0x000055d538f3c9c0 @id=42, @name="Arthur Dent">
+number1 = Config.set(id:1, name: "Stefán Karl Stefánsson")
+ => #<Config::Configuration:0x000055d53866ea00 @id=1, @name="Stefán Karl Stefánsson">
+```
+
+#### Setting it With a Hash
+
+As you noticed, this is how you set it with a hash:
+``` ruby
+Config.set(id:42, name: "Arthur Dent")
+ => #<Config::Configuration:0x000055d538f3c9c0 @id=42, @name="Arthur Dent">
+```
+
+### Setting it with a YAML file
+``` ruby
+Config.yaml_file("/absolute/path/file.yaml")
+ => #<Config::Configuration:0x000055d538ed7d90 @id=42, @name="Arthur Dent", @weapon="Towel">
+```
+
+### Setting it with a JSON file
+``` ruby
+Config.json_file("/absolute/path/file.json")
+ => #<Config::Configuration:0x000055d538a8f210 @id=42, @name="Arthur Dent", @weapon="Towel">
+```
+
+### Setting it with a Environmental Variables
+Be sute the variables are set and accesible
+``` ruby
+ENV["id"] = "42"
+ENV["name"] = "Arthur Dent"
+Config.env_variables("id","name")
+ => #<Config::Configuration:0x000055d538ef8b58 @id="42", @name="Arthur Dent">
+```
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mundo03/config_me.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "config"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/config.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "config_this"
+  spec.version       = Config::VERSION
+  spec.authors       = ["Edmundo Sanchez"]
+  spec.email         = ["zomundo@gmail.com"]
+
+  spec.summary       = "An easy way to create configuration for your gem or script"
+  spec.description   = "Create a configuration object with yaml, json, env variables, or ruby"
+  spec.homepage      = "https://github.com/mundo03/config_me/releases"
+  spec.license       = "MIT"
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/mundo03/config_me/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.17.3"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard", "~> 0.9.2"
+end

data/lib/config.rb

@@ -0,0 +1,67 @@
+require "config/version"
+require "yaml"
+require "json"
+
+# @author Edmundo Sanchez
+# Configuration module
+module Config
+  class Error < StandardError; end
+  # Get configuration
+  # @return [Config] configuration
+  def self.get
+    @configuration ||= Configuration.new
+  end
+  # Set Configuration with a block
+  # @param [Hash] Configuration Hash
+  def self.set(config)
+    @configuration = Configuration.new do |conf|
+      config.each do |key,value|
+        conf.instance_variable_set("@#{key}",value)
+      end
+    end
+  end
+  # Reset the configuration to an empty Configuration object
+  def self.reset
+    @configuration = Configuration.new
+  end
+  # Read YAML file and set configuration
+  # @param [String] Absolute Path to Yaml file
+  def self.yaml_file(path)
+    self.set YAML.load_file(path)
+  end
+  # Read JSON file and set configuration
+  # @param [String] Absolute Path to Yaml file
+  def self.json_file(path)
+    file = File.read(path)
+    self.set JSON.parse(file)
+  end
+  # Read Environmental Variables and set configuration
+  # Note All values will be strings by definition
+  # @param [Array] List of Environmental variables
+  def self.env_variables(*variables)
+    variables.map! do |var|
+      [var,ENV[var]]
+    end
+    self.set(Hash[*variables.flatten])
+  end
+
+  class Configuration
+    # If block given, greate all instance variables
+    # @return [Configuration] self
+    def initialize
+      yield(self) if block_given?
+      return self
+    end
+    # Sets any un set instance variables
+    def method_missing(method, *args, &block)
+      attr_name = method.to_s.gsub("=","")
+      self.class.send(:attr_accessor, attr_name) ## Ensure accesor is set
+      # ensure correct behavior if accesor was not set, hence method was missing
+      if self.instance_variable_defined?("@#{attr_name}")
+        self.instance_variable_get("@#{attr_name}")
+      else
+        self.instance_variable_set("@#{attr_name}", args.first)
+      end
+    end
+  end
+end

data/lib/config/version.rb

@@ -0,0 +1,3 @@
+module Config
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: config_this
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Edmundo Sanchez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Create a configuration object with yaml, json, env variables, or ruby
+email:
+- zomundo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config.gemspec
+- lib/config.rb
+- lib/config/version.rb
+homepage: https://github.com/mundo03/config_me/releases
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mundo03/config_me/releases
+  source_code_uri: https://github.com/mundo03/config_me/releases
+  changelog_uri: https://github.com/mundo03/config_me/releases
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: An easy way to create configuration for your gem or script
+test_files: []