module_plus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fad1d024e316d40aad5060a1a5de28cde52a3e6e85ac1ca0e64e647f831500e7
+  data.tar.gz: 1b0574c60e2b7881dbda1f73010b0b0d875996e0e6ed466796d9f97a18976237
+SHA512:
+  metadata.gz: 82344567f0ab7e3dfbba818d364ca67de5b5285c5c535e3938e839504c9d18e7ea36ea7bb3f011fa0d57b3d51b1f621a4d5160e52e0eea8d3afd2616f9611bbd
+  data.tar.gz: bde7f908ab24f92cb0c1d80f9bb71633a33add66a02e0898fa0c459ae3dde16a824f5309c72d47fa4a553315cd2c944c566170c48e99f0fa5db553a4c3b98383

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,29 @@
+
+AllCops:
+  Include:
+    - 'Gemfile'
+  Exclude:
+    - 'bin/**/*'
+    - 'vender/**/*'
+    - 'spec/**/*'
+
+FileName:
+  Exclude:
+    - '**/Rakefile'
+    - '**/Gemfile'
+
+# Use UTF-8 as the source file encoding.
+Encoding:
+  Enabled: false
+
+#
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+#
+Style/Documentation:
+  Enabled: false
+
+#
+Style/RedundantSelf:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at satoyama@linkode.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 satoyama
+
+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,59 @@
+# ModulePlus
+
+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/module_plus`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'module_plus'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install module_plus
+
+## Usage
+
+ModulePlus prevent you mistaking usage of module with 'extend/include'.
+
+
+```ruby
+require 'module_plus'
+
+module M
+  extend ExtendOnly
+end
+
+class S
+  extend M
+end
+
+class E
+  include ExtendOnly
+end
+```
+
+
+## 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/[USERNAME]/module_plus. 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](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,7 @@
+# Rakefile
+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 "module_plus"
+
+# 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/lib/module_plus.rb

@@ -0,0 +1,8 @@
+#-*- mode: ruby; coding: utf-8 -*-
+
+require 'module_plus/version'
+require 'module_plus/attribute'
+require 'module_plus/identification'
+
+module ModulePlus
+end

data/lib/module_plus/attribute.rb

@@ -0,0 +1,34 @@
+#-*- mode: ruby; coding: utf-8 -*-
+
+require 'module_plus/exception'
+
+module ModulePlus
+  module Attribute
+    include ModulePlus::Exception
+    module ExtendGuard
+      def extended(klass)
+        raise NotPermittedToExtend, "#{self.name} by #{klass}"
+      end
+    end
+
+    module IncludeGuard
+      def included(klass)
+        raise NotPermittedToInclude, "#{self.name} by #{klass}"
+      end
+    end
+
+    module ExtendOnly
+      extend IncludeGuard
+      def self.extended(klass)
+        klass.extend(IncludeGuard)
+      end
+    end
+
+    module IncludeOnly
+      extend ExtendGuard
+      def self.included(klass)
+        klass.extend(ExtendGuard)
+      end
+    end
+  end
+end

data/lib/module_plus/config_convention.rb

@@ -0,0 +1,184 @@
+# -*-mode: ruby; coding: utf-8 -*-
+
+require 'module_plus/attribute'
+require 'module_plus/identification'
+require 'module_plus/core_ext/string'
+require 'module_plus/core_ext/hash'
+
+require 'ostruct'
+require 'pathname'
+require 'yaml'
+
+
+module ModulePlus
+
+  module ConfigConvention
+    include ModulePlus::Attribute
+    extend ExtendOnly
+
+    class << self
+      def extended(klass)
+        super
+        klass.extend(ModulePlus::Identification)
+      end
+
+      attr_reader :config_hash
+
+      def add_def(c)
+        array = (c.path << c.key.to_s).reverse
+        h = array.inject(c.sample){ |h, k| {k => h}}
+        @config_hash ||= Hash.new { |h,k| h[k] = Hash.new(&h.default_proc) }
+        @config_hash.deep_merge!( h )
+
+      end
+
+      def field_path_position_top
+        @field_path_position ||= 0
+      end
+
+      def field_path_position_no_head
+        @field_path_position ||= 1
+      end
+
+      def field_path(array)
+        field_path_position_no_head
+        array.drop(@field_path_position)
+      end
+
+      def config_file=(f)
+        @config_file ||= f
+      end
+
+      def config_file
+        @config_file || 'config.yml'
+      end
+
+      def root_dir=(d)
+        @config_root = d
+      end
+
+      def root_dir
+        @config_root || ENV['HOME']
+      end
+
+      def config_dir=(d)
+        @config_dir ||= d
+      end
+
+      def config_dir
+        @config_dir
+      end
+
+      def dump(fs)
+        YAML.dump(@config_hash, fs)
+      end
+    end
+
+    def config
+      @_config ||= config_load
+    end
+
+    #
+
+    def config_dir
+      Pathname.new(ConfigConvention.root_dir)
+        .join(ConfigConvention.config_dir || '.' + root_name.underscore)
+    end
+    
+    def config_file
+      config_dir.join(ConfigConvention.config_file)
+    end
+
+    protected
+
+    def config_def(key, attributes = {} )
+      @config_defs ||= {}
+      c = ConfigDef.new(key, field_path, attributes)
+      @config_defs[c.key] = c
+      ConfigConvention.add_def(c)
+    end
+
+    attr_reader :config_defs
+
+
+    private
+    def config_load
+      if config_file.exist? and yaml = YAML.load_file(config_file)                
+        c = field_path.inject(yaml) do |h, k|
+          if h[k].is_a? Hash
+            h[k]
+          else
+            raise NotFoundField.new( "Not Found Field #{k} in #{config_file}")
+          end
+        end
+        diff = @config_defs.keys - c.keys
+        raise NotFoundField.new( "Field Key: #{diff.join(", ")} in #{} #{config_file}") unless diff.empty?
+        @config_defs.values.each do |d|
+          c[d.key] = d.value(c[d.key])
+        end
+        ost = OpenStruct.new(c)
+        ost.freeze
+      else
+        ost = OpenStruct.new
+        ost.freeze
+      end
+    end
+
+    def field_path
+      ConfigConvention.field_path(full_names.map{ |str| str.underscore })
+    end
+  end
+
+  class ConfigDef
+    attr_reader :key, :type, :desc, :path, :sample
+    def initialize(key, path, attributes = {})
+      @key  = key.to_s
+      @path = path
+      @desc = attributes[:desc] || ""
+      @type = _type(attributes[:type])
+      @type_strict = _type_strict(@type)
+      @sample = attributes[:sample] || _sample(@type)
+    end
+
+    def field
+      "#{@path.join(".")}.#{@key}"
+    end
+
+    def value(v)
+      raise new NotPermitedValueType.new("#{path}.#{@key}: #{v} is NOT Matched Type for #{@type}") unless @type_strict.call(v)
+      v
+    end
+
+    private
+    def _type(t)
+      (t && t.downcase.to_sym) || :string
+    end
+
+    def _sample(type)
+      case type
+      when :string       then; 'string'
+      when :int          then; 0
+      when :float        then; 0.1
+      when :boolean      then; true
+      when :string_array then; ['string']
+      when :int_array    then; [0]
+      when :float_array  then; [0.1]
+      else
+        nil
+      end
+    end
+    def _type_strict(t)
+      case t
+      when :string       then; -> (v){ v.is_a? String  }
+      when :int          then; -> (v){ v.is_a? Numeric }
+      when :float        then; -> (v){ v.is_a? Numeric }
+      when :boolean      then; -> (v){ v.is_a? TrueClass or v.is_a? FalseClass }
+      when :string_array then; -> (v){ v.is_a? Array and v.all?{ |s| s.is_a? String } }
+      when :int_array    then; -> (v){ v.is_a? Array and v.all?{ |s| s.is_a? Numeric } }
+      when :float_array  then; -> (v){ v.is_a? Array and v.all?{ |s| s.is_a? Numeric } }
+      else
+        raise NotPermitedValueType.new( "Type #{t} of Config Key:#{@key} - #{desc} in #{path}")
+      end
+    end
+  end
+end

data/lib/module_plus/core_ext/hash.rb

@@ -0,0 +1,36 @@
+#-*- mode: ruby; coding: utf-8 -*-
+
+
+#
+# refer activesupport
+#
+# https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
+#
+
+module ModulePlus
+  module CoreExt
+    module Hash
+
+      def deep_merge(other_hash, &block)
+        dup.deep_merge!(other_hash, &block)
+      end
+
+      # Same as +deep_merge+, but modifies +self+.
+      def deep_merge!(other_hash, &block)
+        merge!(other_hash) do |key, this_val, other_val|
+          if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+            this_val.deep_merge(other_val, &block)
+          elsif block_given?
+            block.call(key, this_val, other_val)
+          else
+            other_val
+          end
+        end
+      end
+    end
+  end
+end
+
+class Hash
+  include ModulePlus::CoreExt::Hash
+end

data/lib/module_plus/core_ext/string.rb

@@ -0,0 +1,39 @@
+# -*-mode: ruby; coding: utf-8 -*-
+
+module ModulePlus
+  module CoreExt
+    module String
+      #
+      # Camel case string to under score string
+      #
+      # double column("::") to slash("/")
+      # dash("-") to underscore("_")
+      # reference ActiveSupport (MIT License)
+      # https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflector/methods.rb#L92
+      #
+      def self.underscore(origin)
+        return origin unless /[A-Z-]|::/.match?(origin)
+        word = origin.to_s.gsub('::', '/')
+        word.gsub!(acronyms_underscore_regex) { "#{$1 && '_'.freeze }#{$2.downcase}" }
+        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2'.freeze)
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2'.freeze)
+        word.tr!("-".freeze, "_".freeze)
+        word.downcase!
+        word
+      end
+
+      def self.acronyms_underscore_regex
+        /(?:(?<=([A-Za-z\d]))|\b)(#{acronym_regex})(?=\b|[^a-z])/
+      end
+      def self.acronym_regex
+        /(?=a)b/
+      end
+    end
+  end
+end
+
+class String
+  def underscore
+    ModulePlus::CoreExt::String.underscore(self)
+  end
+end

data/lib/module_plus/exception.rb

@@ -0,0 +1,14 @@
+#-*- mode: ruby; coding: utf-8 -*-
+
+module ModulePlus
+  module Exception
+    class NotImplemented          < StandardError; end
+    class CouldNotWrite           < StandardError; end
+    class NotPermittedToInclude   < StandardError; end
+    class NotPermittedToExtend    < StandardError; end
+    class NotInitializedYet       < StandardError; end
+    class NotPermitedValueType    < StandardError; end
+    class NotFoundField           < StandardError; end
+    
+  end
+end

data/lib/module_plus/identification.rb

@@ -0,0 +1,53 @@
+#-*- mode: ruby; coding: utf-8 -*-
+
+require 'module_plus/attribute'
+require 'module_plus/exception'
+
+module ModulePlus
+  module Identification
+    def full_name
+      my_klass.to_s
+    end
+    def full_names
+      full_name.split(/::/)
+    end
+    def nest_names
+      full_names.inject([]) do |list, name|
+        list << (list.empty? ? name : "#{list.last}::#{name}")
+      end
+    end
+
+    def root_name
+      nest_names.first
+    end
+
+    def outer_names
+      r = nest_names
+      r.take(r.size - 1)
+    end
+
+    def nests
+      #
+      nest_names.map { |name| eval(name) } # rubocop:disable Security/Eval
+    end
+
+    def root
+      eval(root_name) # rubocop:disable Security/Eval
+    end
+
+    def outers
+      outer_names.map { |n| eval(n) } # rubocop:disable Security/Eval
+    end
+
+    private
+
+
+    def my_klass
+      if self.is_a? Module
+        self
+      else
+        self.class
+      end
+    end
+  end
+end

data/lib/module_plus/version.rb

@@ -0,0 +1,5 @@
+#-*- mode: ruby; coding: utf-8 -*-
+
+module ModulePlus
+  VERSION = '0.1.0'.freeze
+end

data/module_plus.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'module_plus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'module_plus'
+  spec.version       = ModulePlus::VERSION
+  spec.authors       = ['satoyama']
+  spec.email         = ['satoyama@linkode.co.jp']
+
+  spec.summary       = 'Module + Utilities'
+  spec.description   = 'To include/extend utilites for ruby "Module" or "Class".'
+  spec.homepage      = 'https://github.com/linkodehub/module_plus'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.14'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: module_plus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- satoyama
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: To include/extend utilites for ruby "Module" or "Class".
+email:
+- satoyama@linkode.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/module_plus.rb
+- lib/module_plus/attribute.rb
+- lib/module_plus/config_convention.rb
+- lib/module_plus/core_ext/hash.rb
+- lib/module_plus/core_ext/string.rb
+- lib/module_plus/exception.rb
+- lib/module_plus/identification.rb
+- lib/module_plus/version.rb
+- module_plus.gemspec
+homepage: https://github.com/linkodehub/module_plus
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Module + Utilities
+test_files: []