miller 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: dd7859e144e539b6ecfce5a50a5efabbc82bd547165131f3f53e0a1d56212662
4
+ data.tar.gz: 2d532305ac684f70d59479683d5a32d8e531ac34a0e01abb2c84b7dad5a650e7
5
+ SHA512:
6
+ metadata.gz: 23a58b6b24a434f0eb614cc7ad6c27cd340ee5036c31b3c17cbbbd1d3f24beffeb197dbc946bf982996a752403b8d4f3d8c45ccade5633393954e5cc0a50048d
7
+ data.tar.gz: 95ce3f81ec1456aae3532a9a5829dbd051e19fa5ec5358543a3edfcb8e944fcae8476e2ef83e845894744821a275f7c55350ac8123f3cb1a9fcd6bffede952d4
@@ -0,0 +1,11 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.5.1
7
+ before_install: gem install bundler -v 1.16.4
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at arturictus@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in miller.gemspec
6
+ gemspec
7
+ gem 'pry'
@@ -0,0 +1,45 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ miller (0.1.0)
5
+ erlash (~> 0.1)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ coderay (1.1.2)
11
+ diff-lcs (1.3)
12
+ erlash (0.1.0)
13
+ fusu
14
+ fusu (0.2.0)
15
+ method_source (0.9.2)
16
+ pry (0.12.2)
17
+ coderay (~> 1.1.0)
18
+ method_source (~> 0.9.0)
19
+ rake (10.5.0)
20
+ rspec (3.8.0)
21
+ rspec-core (~> 3.8.0)
22
+ rspec-expectations (~> 3.8.0)
23
+ rspec-mocks (~> 3.8.0)
24
+ rspec-core (3.8.0)
25
+ rspec-support (~> 3.8.0)
26
+ rspec-expectations (3.8.2)
27
+ diff-lcs (>= 1.2.0, < 2.0)
28
+ rspec-support (~> 3.8.0)
29
+ rspec-mocks (3.8.0)
30
+ diff-lcs (>= 1.2.0, < 2.0)
31
+ rspec-support (~> 3.8.0)
32
+ rspec-support (3.8.0)
33
+
34
+ PLATFORMS
35
+ ruby
36
+
37
+ DEPENDENCIES
38
+ bundler (~> 1.16)
39
+ miller!
40
+ pry
41
+ rake (~> 10.0)
42
+ rspec (~> 3.0)
43
+
44
+ BUNDLED WITH
45
+ 1.16.4
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 Artur
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.
@@ -0,0 +1,160 @@
1
+ # Miller
2
+
3
+ Write beautiful and descriptive code by adding configurable services with DSLs
4
+ in a quick and easy manner.
5
+
6
+ ## Installation
7
+
8
+ Add this line to your application's Gemfile:
9
+
10
+ ```ruby
11
+ gem 'miller'
12
+ ```
13
+
14
+ And then execute:
15
+
16
+ $ bundle
17
+
18
+ Or install it yourself as:
19
+
20
+ $ gem install miller
21
+
22
+ ## Usage
23
+
24
+ ```ruby
25
+ class ServiceBase
26
+ include Miller.with(:name, :lastname)
27
+ def full_name
28
+ "#{name} #{lastname}"
29
+ end
30
+ # write your logic here
31
+ end
32
+
33
+ class Service < ServiceBase
34
+ name 'John'
35
+ lastname 'Doe'
36
+ end
37
+
38
+ Service.config.name # => 'John'
39
+ Service.config.lastname # => 'Doe'
40
+ inst = Service.new
41
+ inst.name # => 'John'
42
+ inst.lastname # => 'Doe'
43
+ inst.full_name # => 'John Doe'
44
+ ```
45
+
46
+ __IMPORTANT:__ Usually you will create a base class and then inherit from it for clarity as the previous example shows. The following examples are just to explain the features.
47
+
48
+ ### Blocks
49
+
50
+ ```ruby
51
+ class Service
52
+ include Miller.with(:name, :lastname)
53
+ name { another_name }
54
+ lastname 'Doe'
55
+
56
+ def another_name
57
+ "victor"
58
+ end
59
+ end
60
+ Service.config.name # => Proc
61
+ Service.config.lastname # => 'Doe'
62
+ inst = Service.new
63
+ inst.name # => 'victor'
64
+ inst.lastname # => 'Doe'
65
+ ```
66
+
67
+ ### Default Config
68
+
69
+ ```ruby
70
+ class Service
71
+ include Miller.with(:name, :lastname, default_config: { name: 'Henry', lastname: 'Miller' })
72
+ lastname 'Doe'
73
+ end
74
+ Service.config.name # => 'Henry'
75
+ Service.config.lastname # => 'Doe'
76
+ inst = Service.new
77
+ inst.name # => 'Henry'
78
+ inst.lastname # => 'Doe'
79
+ ```
80
+
81
+ ### Inheritance
82
+
83
+ If you require configs to be inherited by children use the following.
84
+
85
+ ```ruby
86
+ class ServiceBase < Miller.base(:name, :lastname)
87
+ name 'John'
88
+ lastname 'Doe'
89
+ end
90
+ class Service < ServiceBase; end
91
+ Service.config.name # => 'John'
92
+ Service.config.lastname # => 'Doe'
93
+ inst = Service.new
94
+ inst.name # => 'John'
95
+ inst.lastname # => 'Doe'
96
+ ```
97
+
98
+ ### Override at instance level
99
+
100
+ __WARNING:__ This can be useful but very dangerous please use it carefully.
101
+
102
+ ```ruby
103
+ class Service
104
+ include Miller.with(:name, :lastname)
105
+ name 'John'
106
+ lastname 'Doe'
107
+ end
108
+ Service.config.name # => 'John'
109
+ Service.config.lastname # => 'Doe'
110
+ inst = Service.new
111
+ inst.name = 'Henry'
112
+ inst.name # => 'Henry'
113
+ inst.lastname # => 'Doe'
114
+ ```
115
+
116
+ ```ruby
117
+ class Service
118
+ include Miller.with(:name, :lastname)
119
+ name 'John'
120
+ lastname 'Doe'
121
+ def another_name
122
+ 'Martha'
123
+ end
124
+ end
125
+ Service.config.name # => 'John'
126
+ Service.config.lastname # => 'Doe'
127
+ inst = Service.new
128
+ inst.name = proc { another_name }
129
+ inst.name # => 'Martha'
130
+ inst.lastname # => 'Doe'
131
+ ```
132
+
133
+ ### Errors
134
+
135
+ ```ruby
136
+ class Service
137
+ include Miller.with(:name, :lastname)
138
+ name 'John'
139
+ lastname 'Doe'
140
+ end
141
+ Service.config.foo # => Miller::ConfigNotSetError
142
+ ```
143
+
144
+ ## Development
145
+
146
+ 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.
147
+
148
+ 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).
149
+
150
+ ## Contributing
151
+
152
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/miller. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
153
+
154
+ ## License
155
+
156
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
157
+
158
+ ## Code of Conduct
159
+
160
+ Everyone interacting in the Miller project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/miller/blob/master/CODE_OF_CONDUCT.md).
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "miller"
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(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,104 @@
1
+ require "erlash"
2
+ require "miller/version"
3
+ require "miller/errors"
4
+
5
+ module Miller
6
+ include Errors
7
+ def self.with(*attrs)
8
+
9
+ opts = extract_options!(attrs)
10
+
11
+ config_class = Class.new(Hash) do
12
+ alias_method :get, :[]
13
+ alias_method :set, :[]=
14
+ def self.build(hash)
15
+ hash.each_with_object(new) do |(k, v), o|
16
+ o[k] = v
17
+ end
18
+ end
19
+ attrs.each do |attr|
20
+ define_method attr do
21
+ get(attr)
22
+ end
23
+ end
24
+
25
+ def method_missing(name, *args, &block)
26
+ raise ConfigNotSetError, { name: name }
27
+ end
28
+ end
29
+
30
+ class_methods = Module.new do
31
+
32
+ define_method :config do
33
+ @config ||= config_class.build(opts[:default_config] || {})
34
+ end
35
+
36
+ def _set_config_from_inheritance(config)
37
+ @config = config
38
+ end
39
+
40
+ attrs.each do |attr|
41
+ define_method attr do |val = nil, &block|
42
+ config.set(attr, (block || val))
43
+ end
44
+ end
45
+ end
46
+
47
+ instance_module = Module.new do
48
+ def config
49
+ self.class.config
50
+ end
51
+ attrs.each do |attr|
52
+ define_method attr do
53
+ result = instance_variable_get("@#{attr}")
54
+ if result
55
+ _extract_config(result)
56
+ else
57
+ _extract_config(self.class.config.get(attr))
58
+ end
59
+ end
60
+ end
61
+ attr_writer *attrs
62
+
63
+ private
64
+
65
+ def _extract_config(val)
66
+ if val.respond_to?(:call)
67
+ instance_exec(&val)
68
+ else
69
+ val
70
+ end
71
+ end
72
+ end
73
+
74
+ Module.new do
75
+ singleton_class.send :define_method, :included do |host_class|
76
+ host_class.extend class_methods
77
+ host_class.include instance_module
78
+ end
79
+ end
80
+ end
81
+
82
+ def self.base(*args)
83
+ Class.new do
84
+ include Miller.with(*args)
85
+ def self.inherited(subclass)
86
+ unless config.empty?
87
+ subclass._set_config_from_inheritance(config.dup)
88
+ end
89
+ end
90
+ end
91
+ end
92
+
93
+ def self.extract_options!(ary)
94
+ if ary.last.is_a?(Hash) && extractable_options?(ary.last)
95
+ ary.pop
96
+ else
97
+ {}
98
+ end
99
+ end
100
+
101
+ def self.extractable_options?(elem)
102
+ elem.instance_of?(Hash)
103
+ end
104
+ end
@@ -0,0 +1,13 @@
1
+ module Miller
2
+ module Errors
3
+ class ConfigNotSetError < Erlash::Base
4
+ display_context false
5
+ problem do |c|
6
+ "Config not set: `#{c[:name]}`"
7
+ end
8
+ resolution do |c|
9
+ "Register the config when including Miller, ex: `include Miller.with(:#{c[:name]})`"
10
+ end
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,3 @@
1
+ module Miller
2
+ VERSION = "0.1.1"
3
+ end
@@ -0,0 +1,30 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "miller/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "miller"
8
+ spec.version = Miller::VERSION
9
+ spec.authors = ["Artur Panach"]
10
+ spec.email = ["arturictus@gmail.com"]
11
+
12
+ spec.summary = %q{DSL builder}
13
+ spec.description = %q{Write beautiful and descriptive code by adding configurable services with DSLs in a quick and easy manner.}
14
+ spec.homepage = "http://github.com/arturictus/miller"
15
+ spec.license = "MIT"
16
+
17
+ # Specify which files should be added to the gem when it is released.
18
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
19
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
20
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
21
+ end
22
+ spec.bindir = "exe"
23
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
24
+ spec.require_paths = ["lib"]
25
+
26
+ spec.add_development_dependency "bundler", "~> 1.16"
27
+ spec.add_development_dependency "rake", "~> 10.0"
28
+ spec.add_development_dependency "rspec", "~> 3.0"
29
+ spec.add_dependency "erlash", "~> 0.1"
30
+ end
metadata ADDED
@@ -0,0 +1,116 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: miller
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - Artur Panach
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2019-01-18 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.16'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.16'
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
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: erlash
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '0.1'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '0.1'
69
+ description: Write beautiful and descriptive code by adding configurable services
70
+ with DSLs in a quick and easy manner.
71
+ email:
72
+ - arturictus@gmail.com
73
+ executables: []
74
+ extensions: []
75
+ extra_rdoc_files: []
76
+ files:
77
+ - ".gitignore"
78
+ - ".rspec"
79
+ - ".travis.yml"
80
+ - CODE_OF_CONDUCT.md
81
+ - Gemfile
82
+ - Gemfile.lock
83
+ - LICENSE.txt
84
+ - README.md
85
+ - Rakefile
86
+ - bin/console
87
+ - bin/setup
88
+ - lib/miller.rb
89
+ - lib/miller/errors.rb
90
+ - lib/miller/version.rb
91
+ - miller.gemspec
92
+ homepage: http://github.com/arturictus/miller
93
+ licenses:
94
+ - MIT
95
+ metadata: {}
96
+ post_install_message:
97
+ rdoc_options: []
98
+ require_paths:
99
+ - lib
100
+ required_ruby_version: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - ">="
103
+ - !ruby/object:Gem::Version
104
+ version: '0'
105
+ required_rubygems_version: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - ">="
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ requirements: []
111
+ rubyforge_project:
112
+ rubygems_version: 2.7.6
113
+ signing_key:
114
+ specification_version: 4
115
+ summary: DSL builder
116
+ test_files: []