easy_set 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 288f4ad462e4af2a18034367a014bd840ed6be28
4
+ data.tar.gz: f36c05d72df78b6297d0b57d6d5fc8e1e9134ed5
5
+ SHA512:
6
+ metadata.gz: 60316e59dbb04db530d788387d4d9f0ef4a0ca47c0a8dd059463569348e8c384979b68f720f7fbac79ba27bf2a6cd634cce53aff50e056aa7fe1e4bd8379eef5
7
+ data.tar.gz: a834725a75bf313742db873bd278f9a5dbaa60fdb41f92ef24dcdc9831daf770533651fb40b7566ef8246fc34db5575351f980098e33e986c84db4faa0079505
data/.gitignore ADDED
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ *.gem
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+ We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6
+
7
+ Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8
+
9
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in easy_set.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 Martin Becker
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,92 @@
1
+ # EasySet
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/easy_set`. 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
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'easy_set'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install easy_set
22
+
23
+ ## Usage
24
+
25
+ To use the this library is easy.
26
+
27
+ First create your storing class like this:
28
+
29
+ ```ruby
30
+ class Config
31
+ include Easy_Set
32
+ end
33
+ ```
34
+
35
+ and then adding settings like this:
36
+
37
+ ```ruby
38
+ class Config
39
+ include Easy_Set
40
+ set :root, File.expand_path('.',File.dirname(__FILE__))
41
+ set :name, 'GemNameCouldGoHere'
42
+ set :port, 30045
43
+ set :url, 'some_url.com/endpoint'
44
+ set :credentials, {
45
+ key: 'some_key',
46
+ secret: 'some_secret'
47
+
48
+ }
49
+ end
50
+ ```
51
+
52
+ and that's it, to access the data you can just do:
53
+
54
+ ```ruby
55
+ some_function_requiring_a_url(Config[:url])
56
+ ```
57
+
58
+ You can also generate a random string of numbers/text for use in secret keys like this:
59
+
60
+ ```ruby
61
+ class Config
62
+ include Easy_Set
63
+ set :key, generate_rand_string(128) #this will generate a string of random numbers & letters 128 characters long
64
+ end
65
+ ```
66
+
67
+ Lastly you can load in a yaml file for config purposes
68
+
69
+ ```ruby
70
+ Config.load_config_from('some_path')
71
+ ```
72
+
73
+ and it can be accessed like this:
74
+
75
+ ```ruby
76
+ Config[:config]
77
+ ```
78
+
79
+ ## Development
80
+
81
+ After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
82
+
83
+ 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).
84
+
85
+ ## Contributing
86
+
87
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/easy_set. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
88
+
89
+
90
+ ## License
91
+
92
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "easy_set"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
data/easy_set.gemspec ADDED
@@ -0,0 +1,23 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'easy_set/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "easy_set"
8
+ spec.version = EasySet::VERSION
9
+ spec.authors = ["Martin Becker"]
10
+ spec.email = ["mbeckerwork@gmail.com"]
11
+
12
+ spec.summary = %q{This Gem allows the easy creation of a settings class}
13
+ spec.homepage = "https://github.com/Thermatix/easy_set"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
17
+ spec.bindir = "exe"
18
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.10"
22
+ spec.add_development_dependency "rake", "~> 10.0"
23
+ end
@@ -0,0 +1,3 @@
1
+ module EasySet
2
+ VERSION = "0.1.0"
3
+ end
data/lib/easy_set.rb ADDED
@@ -0,0 +1,48 @@
1
+ require "./easy_set/version"
2
+
3
+ require 'yaml'
4
+ module Easy_Set
5
+
6
+ module Singleton_Methods
7
+
8
+ def [](key)
9
+ @store[key]
10
+ end
11
+
12
+ def display
13
+ @store.inspect
14
+ end
15
+
16
+ def generate_rand_string(length=nil)
17
+ o = [('a'..'z'), ('A'..'Z')].map { |i| i.to_a }.flatten
18
+ return (0...(length||32)).map { o[rand(o.length)] }.join
19
+ end
20
+
21
+ def load_config_from path
22
+ @store[:config] = YAML.load_file(path)
23
+ end
24
+
25
+ def to_s
26
+ @store.each do |key,value|
27
+ puts "#{key}: #{value.to_s}"
28
+ end
29
+ puts ""
30
+ end
31
+
32
+ private
33
+ def set key, value
34
+ @store[key] = value
35
+ end
36
+
37
+ end
38
+
39
+
40
+ def self.included(child)
41
+ child.instance_variable_set(:@store, {})
42
+ child.extend(Singleton_Methods)
43
+ end
44
+
45
+ def self.includes_hooks?
46
+ %w(inherited)
47
+ end
48
+ end
metadata ADDED
@@ -0,0 +1,84 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: easy_set
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Martin Becker
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-11-30 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.10'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.10'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ description:
42
+ email:
43
+ - mbeckerwork@gmail.com
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - ".gitignore"
49
+ - CODE_OF_CONDUCT.md
50
+ - Gemfile
51
+ - LICENSE.txt
52
+ - README.md
53
+ - Rakefile
54
+ - bin/console
55
+ - bin/setup
56
+ - easy_set.gemspec
57
+ - lib/easy_set.rb
58
+ - lib/easy_set/version.rb
59
+ homepage: https://github.com/Thermatix/easy_set
60
+ licenses:
61
+ - MIT
62
+ metadata: {}
63
+ post_install_message:
64
+ rdoc_options: []
65
+ require_paths:
66
+ - lib
67
+ required_ruby_version: !ruby/object:Gem::Requirement
68
+ requirements:
69
+ - - ">="
70
+ - !ruby/object:Gem::Version
71
+ version: '0'
72
+ required_rubygems_version: !ruby/object:Gem::Requirement
73
+ requirements:
74
+ - - ">="
75
+ - !ruby/object:Gem::Version
76
+ version: '0'
77
+ requirements: []
78
+ rubyforge_project:
79
+ rubygems_version: 2.4.5.1
80
+ signing_key:
81
+ specification_version: 4
82
+ summary: This Gem allows the easy creation of a settings class
83
+ test_files: []
84
+ has_rdoc: