dsl_organizer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0464926e6b26e1355e699856ba42e8f89782a0a58b55e546597e374d91def83
+  data.tar.gz: 007313d81abe50444de1f19d8eb2359e40c5ee4edf4644db64da033221f66693
+SHA512:
+  metadata.gz: f30beec2fb5b11b817b828f3705c3425aad580692ca75acd23ee11f741c30a07092c1b3d29bda5691c15c3e5980a7a472dabaf7d8c0169fd422d530c57962acd
+  data.tar.gz: b86ec90887722601706474e10b9e16cb18bd635b9bba9653051133398d8099d4773085984db51cd518031f36a8898c6fd92360340604de8f396ae345cf3f240e

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/
+.byebug_history
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,7 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'dsl_organizer.gemspec'
+    - 'spec/**/*'
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/dsl_organizer/core.rb'

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  add_filter '/spec/'
+end

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+dist: trusty
+sudo: required
+cache: bundler
+bundler_args: --without console
+script:
+  - bundle exec rake spec
+after_success:
+  - '[ -d coverage ] && bundle exec codeclimate-test-reporter'
+rvm:
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    dsl_organizer (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.0.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    jaro_winkler (1.5.2)
+    json (2.2.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.65.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17.2, >= 1.17.2)
+  byebug (~> 11.0.0)
+  dsl_organizer!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.65)
+  simplecov (~> 0.16.1)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Artem Rumiantcev
+
+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,90 @@
+# DslOrganizer [![Build Status](https://travis-ci.com/TemaMix/dsl_organizer.svg?branch=master)](https://travis-ci.com/TemaMix/dsl_organizer) [![Code Climate](https://codeclimate.com/github/TemaMix/dsl_organizer.svg)](https://codeclimate.com/github/TemaMix/dsl_organizer) 
+
+DslOrganizer provides a simple way to create self dsl and allows to integrate dsl to logic easy.
+
+## Installation
+
+Installation is pretty standard:
+
+```
+$ gem install dsl_organizer
+```
+
+If you use bundler to add it to your Gemfile:
+```
+gem 'dsl_organizer', '~> 1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+### Brief Example
+1. Firstly, you should think up commands for your dsl.
+```ruby
+module Configuration
+ include DslOrganizer.dictionary(
+   commands: [:font_colors, :backgrounds]
+  )
+end
+```
+2. Secondly, you should define executors for your commands and export them.
+```ruby
+class FontColorExecutor
+  include DslOrganizer::ExportCommand[:font_colors]
+  
+  def call(font_color)
+     colors << font_color
+  end
+  
+  def colors
+     @colors ||= []
+  end
+end
+
+class BackroundExecutor
+  include DslOrganizer::ExportCommand[:backgrounds]
+  
+  def call(backround_color)
+     colors << backround_color
+  end
+  
+  def colors
+     @colors ||= []
+  end
+end
+```
+3. Thirdly, described logic with using dsl commands can look something like that: 
+ ```ruby
+Configuration.run do
+  font_colors'#AAA'
+  font_colors '#BBB'
+  backgrounds '#CCC'
+end
+ ```
+ The dsl commands `color` and `background` will executed immediately.
+
+4. Finally, you can integrate commands to basic logic to use for it the Dependency Injection pattern:
+ ```ruby
+module Configuration
+  def self.print_all_colors
+    dsl_container[:font_colors].colors.map do |color|
+      puts color
+    end
+    
+    dsl_container[:backgrounds].colors.map do |color|
+      puts color
+    end
+  end
+end
+ ```
+ 
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/temamix/dsl_organizer. 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.
+
+## 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,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec rubocop]
+RSpec::Core::RakeTask.new
+
+desc 'Run RuboCop checks'
+RuboCop::RakeTask.new

data/dsl_organizer.gemspec

@@ -0,0 +1,45 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dsl_organizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dsl_organizer'
+  spec.version       = DslOrganizer::VERSION
+  spec.authors       = ['Artem Rumiantcev']
+  spec.email         = ['tema.place@gmail.com']
+
+  spec.summary       = 'DSL organizer allows to add flexible' \
+                       ' and readable dsl handlers to your project.'
+  spec.homepage      = 'http://github.com/TemaMix/dsl_organizer'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org.
+  # To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host
+  # or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # 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(__dir__)) 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.2', '>= 1.17.2'
+  spec.add_development_dependency 'byebug', '~> 11.0.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.65'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
+end

data/examples/example1/colors_configuration.rb

@@ -0,0 +1,61 @@
+# Example 1
+#
+# Current structure shows as the DslOrganizer can use to create a basic dsl
+# in your program.
+#
+# After execution it in the terminal is printed follow:
+#   `execute before something happen`
+#   `execute some process`
+#   `execute after something happen`
+
+require 'dsl_organizer'
+
+class FontColorExecutor
+  include DslOrganizer::ExportCommand[:font_colors]
+
+  def call(font_color)
+    colors << font_color
+  end
+
+  def colors
+    @colors ||= []
+  end
+end
+
+class BackroundExecutor
+  include DslOrganizer::ExportCommand[:backgrounds]
+
+  def call(backround_color)
+    colors << backround_color
+  end
+
+  def colors
+    @colors ||= []
+  end
+end
+
+module Configuration
+  include DslOrganizer.dictionary(
+    commands: %i[font_colors backgrounds]
+  )
+end
+
+Configuration.run do
+  font_colors '#AAA'
+  font_colors '#BBB'
+  backgrounds '#CCC'
+end
+
+module Configuration
+  def self.print_all_colors
+    dsl_container[:font_colors].colors.map do |color|
+      puts color
+    end
+
+    dsl_container[:backgrounds].colors.map do |color|
+      puts color
+    end
+  end
+end
+
+Configuration.print_all_colors

data/examples/example2/hooks.rb

@@ -0,0 +1,78 @@
+# Example 2
+#
+# Current structure shows as the DslOrganizer can use to create hooks in your
+# program.
+#
+# After execution it in the terminal is printed follow:
+#   `execute before something happen`
+#   `execute some process`
+#   `execute after something happen`
+
+require 'dsl_organizer'
+
+class AfterHook
+  include DslOrganizer::ExportCommand[:after]
+
+  def call(&block)
+    hooks.unshift(block)
+  end
+
+  def hooks
+    @hooks ||= []
+  end
+end
+
+class BeforeHook
+  include DslOrganizer::ExportCommand[:before]
+
+  def call(&block)
+    hooks.push(block)
+  end
+
+  def hooks
+    @hooks ||= []
+  end
+end
+
+module HooksOperator
+  def self.included(base)
+    base.class_eval do
+      extend ClassMethods
+    end
+  end
+
+  module ClassMethods
+    def with_hooks
+      run_hooks(dsl_container[:before].hooks)
+      yield
+      run_hooks(dsl_container[:after].hooks)
+    end
+
+    private
+
+    def run_hooks(hooks)
+      hooks.each { |hook| instance_exec(&hook) }
+    end
+  end
+end
+
+module Process
+  include DslOrganizer.dictionary(
+    commands: %i[before after]
+  )
+
+  include HooksOperator
+
+  def self.start
+    with_hooks do
+      puts 'execute some process'
+    end
+  end
+end
+
+Process.run do
+  before { puts 'execute before something happen' }
+  after  { puts 'execute after something happen' }
+end
+
+Process.start

data/lib/dsl_organizer.rb

@@ -0,0 +1,21 @@
+require_relative 'dsl_organizer/errors'
+require_relative 'dsl_organizer/container'
+require_relative 'dsl_organizer/command_container'
+require_relative 'dsl_organizer/export_container'
+require_relative 'dsl_organizer/export_command'
+require_relative 'dsl_organizer/version'
+require_relative 'dsl_organizer/core'
+
+# DslOrganizer allows to build flexible notations very quickly
+# and same time they will understandable.
+# @example:
+#   include DslOrganizer.dictionary(commands: {
+#       before: BeforeHook,
+#       after: AfterHook
+#   })
+# @note:
+#   The idea was found here
+#   https://www.toptal.com/ruby/ruby-dsl-metaprogramming-guide
+module DslOrganizer
+  extend DslOrganizer::Core
+end

data/lib/dsl_organizer/command_container.rb

@@ -0,0 +1,8 @@
+module DslOrganizer
+  # Consist of instance objects of executors (hooks)
+  # @note it allows integrating executors flexibly
+  #       to general logic of your application.
+  class CommandContainer
+    extend Container
+  end
+end

data/lib/dsl_organizer/container.rb

@@ -0,0 +1,20 @@
+module DslOrganizer
+  # It defines methods to operate with executors.
+  module Container
+    def []=(command, executor)
+      real_container[command] = executor
+    end
+
+    def [](command = nil)
+      real_container[command]
+    end
+
+    def real_container
+      @real_container ||= {}
+    end
+
+    def reset
+      @real_container = {}
+    end
+  end
+end

data/lib/dsl_organizer/core.rb

@@ -0,0 +1,88 @@
+module DslOrganizer
+  # Load methods for control dsl commands.
+  module Core
+    # @syntax
+    #   commands: { <command>:<class executor> }
+    # @example
+    #   commands: { after: AfterHook, before: BeforeHook }
+    # @return [Module]
+    def dictionary(commands: [])
+      CommandContainer.reset
+
+      @dsl_commands = commands
+      validate_commands
+
+      dsl_module = new_dsl_module(dsl_operator: new_dsl_operator)
+      Module.new do
+        singleton_class.send :define_method, :included do |host_class|
+          host_class.extend dsl_module
+        end
+      end
+    end
+
+    private
+
+    attr_reader :dsl_commands
+
+    def validate_commands
+      if dsl_commands.nil? || dsl_commands.empty?
+        raise Errors::DslCommandsNotFound, 'Add DSL commands for work'
+      end
+
+      dsl_commands.each do |command|
+        unless ExportContainer.real_container.key?(command)
+          raise(Errors::DslCommandsNotFound,
+                "Add an executor for the `#{command}` command for work")
+        end
+      end
+    end
+
+    def new_dsl_module(dsl_operator:)
+      commands = dsl_commands
+      Module.new do
+        define_method :used_dsl do
+          @used_dsl ||= dsl_operator.new
+        end
+
+        define_method :dsl_commands do
+          @dsl_commands ||= commands
+        end
+
+        define_method :dsl_container do
+          CommandContainer
+        end
+
+        def run(&block)
+          used_dsl.instance_eval(&block)
+        end
+      end
+    end
+
+    def new_dsl_operator
+      commands = dsl_commands
+      Class.new do
+        commands.each do |command|
+          define_method command do |values = [], &block|
+            unless ExportContainer[command].method_defined? :call
+              raise(
+                Errors::MethodCallNotFound,
+                'Not found `call` method for the' \
+                " `#{ExportContainer[command].name}` class and" \
+                " the `#{command}` command"
+              )
+            end
+
+            command_instance = CommandContainer[command] ||
+                               ExportContainer[command].new
+
+            unless CommandContainer[command]
+              CommandContainer[command] = command_instance
+            end
+
+            command_instance.call(*values, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dsl_organizer/errors.rb

@@ -0,0 +1,7 @@
+module DslOrganizer
+  module Errors
+    class DslCommandsNotFound < StandardError; end
+    class ExecutorDidMountEarly < StandardError; end
+    class MethodCallNotFound < StandardError; end
+  end
+end

data/lib/dsl_organizer/export_command.rb

@@ -0,0 +1,27 @@
+module DslOrganizer
+  # It allows to define what a class is a executor (hook).
+  # @note Just include this to the target class and think up a command name.
+  # @example
+  #   include DslOrganizer::ExportCommand[:after]
+  # rubocop:disable Metrics/MethodLength
+  module ExportCommand
+    def self.[](command_name)
+      Module.new do
+        @command_name = command_name
+
+        def self.included(base)
+          if ExportContainer[@command_name].nil?
+            ExportContainer[@command_name] = base
+          else
+            raise(
+              Errors::ExecutorDidMountEarly,
+              "The component for command name: `#{@command_name}`" \
+              ' was mounted early. Avoid duplication naming within commands.'
+            )
+          end
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/dsl_organizer/export_container.rb

@@ -0,0 +1,6 @@
+module DslOrganizer
+  # Consist of classes of executors (hooks).
+  class ExportContainer
+    extend Container
+  end
+end

data/lib/dsl_organizer/version.rb

@@ -0,0 +1,3 @@
+module DslOrganizer
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: dsl_organizer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Artem Rumiantcev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-04 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.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.17.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.2
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.65'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.65'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: 
+email:
+- tema.place@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- dsl_organizer.gemspec
+- examples/example1/colors_configuration.rb
+- examples/example2/hooks.rb
+- lib/dsl_organizer.rb
+- lib/dsl_organizer/command_container.rb
+- lib/dsl_organizer/container.rb
+- lib/dsl_organizer/core.rb
+- lib/dsl_organizer/errors.rb
+- lib/dsl_organizer/export_command.rb
+- lib/dsl_organizer/export_container.rb
+- lib/dsl_organizer/version.rb
+homepage: http://github.com/TemaMix/dsl_organizer
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/TemaMix/dsl_organizer
+  source_code_uri: http://github.com/TemaMix/dsl_organizer
+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.1
+signing_key: 
+specification_version: 4
+summary: DSL organizer allows to add flexible and readable dsl handlers to your project.
+test_files: []