missile_emitter 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a38fa6f5f01a264e3fc00d72befbe12a29e05aec1acf6ef2a79bfe5d4c0373f
+  data.tar.gz: 2e3a55d5fcf2b5d1e2c11d8bebda500e5908ee59bb44d142483e3a31efe288be
+SHA512:
+  metadata.gz: dafcb49660a89127302f3f93710155594937aec1aff16a10d183b4aa609a77a8c4356e001cba112c9edd891057b37c76da2f7680854925789e94fc11d1434e58
+  data.tar.gz: 1c2bea2657c924bab830ead79cc0b48a7f7155e53f6caa0c389a6c241501a570f50ea209b87688726c9924581d61b0ac1edd231f1d9d1c160c6be2d8f4f81133

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.0.2

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 chen.ruijie@gmail.com. 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 missile_emitter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    missile_emitter (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  missile_emitter!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 coding-class-com
+
+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,166 @@
+# MissileEmitter 导弹发射器
+
+Ruby元编程小工具，让你能在类定义（class definition）级别触发 method_missing 事件，同时不用担心潜在的命名冲突（此工具来源于一次本地Ruby集会上的主题分享《[小题大做：Ruby元编程探秘](https://pan.baidu.com/s/1hs5hj04)》）。
+
+Ruby 提供了 `method_missing` 钩子，利用它可以实现很多功能，但其使用场景也是有限的，基本上常见的用法都是在对象级别来触发（BasicObject的实例 就特别合适）。那有没有什么办法，能让我们在类定义级别来实现相同的目标呢？让我们尝试一下：
+
+```ruby
+class MyClass
+  def self.method_missing(message, *args, &block)
+    # 做爱做的事情
+  end
+end
+
+MyClass.ooxx # 触发类级别的 method_missing
+``` 
+
+看似可行？可惜并不完美，大家都知道 `MyClass` 其实是 `Class` 类的实例，因此本身还是会带有很多与生俱来的方法：
+
+```ruby
+p MyClass.methods.size # => 111
+```
+
+其中不乏有 `name`、`trust`这些很常见的名称，导致无法正常触发 `method_missing`，实用性大打折扣。当然，我们可以借助 `undef_method` 来移除不需要的内置方法。以下是 `builder` 的 [BlankSlate](https://github.com/jimweirich/builder/blob/c80100f8205b2e918dbff605682b01ab0fabb866/lib/blankslate.rb#L41) 实现：
+
+```ruby
+class BlankSlate
+  # Hide the method named +name+ in the BlankSlate class.  Don't
+  # hide +instance_eval+ or any method beginning with "__".
+  def self.hide(name)
+    # ...
+    if instance_methods.include?(name._blankslate_as_name) &&
+        name !~ /^(__|instance_eval$)/
+      # ...
+      undef_method name # 利用 undef_method 移除内置方法定义
+    end
+    # ...
+  end
+  # ...
+  instance_methods.each { |m| hide(m) }
+end
+```
+
+当然，这个方案也不完美，很多时候我们并不能简单粗暴地把所有类方法都取消定义，特别是 `name` 这样的（返回类的字符串名称），你懂的。那该怎么办呢？嗯，采用 Missile Emitter 可以做到，在类方法级别绕开内置方法的名称冲突，顺利触发 `method_missing` ！有了它我们就能实现更多有趣的DSL。
+
+## 安装说明
+
+添加下面这行代码到项目的Gemfile文件:
+
+```ruby
+gem 'missile_emitter'
+```
+
+然后命令行执行:
+
+    $ bundle
+
+也可以通过下面的方式直接安装 gem 包:
+
+    $ gem install missile_emitter
+
+## 使用说明
+
+`missile emitter` 需要先定义模块，然后才能在目标类中使用。
+
+1. 定义模块:
+
+```ruby
+module Attributes
+  MissileEmitter do |klass, field, value, *, &block|
+    klass.define_method(field) { value || instance_eval(&block) }
+  end
+end
+```
+
+2. 扩展目标类（同时声明配置项）：
+
+```ruby
+require 'date'
+
+class Person
+  include Attributes {
+    name 'Jerry Chen'
+    sex 'male'
+    birthday Date.parse('1983-08-08')
+    age do
+      (Date.today.strftime('%Y%m%d').to_i - birthday.strftime('%Y%m%d').to_i) / 10000
+    end
+  }
+end
+```
+
+如此一来，我们就实现了在定义类的同时，配置好需要的属性，测试一下：
+
+```ruby
+me = Person.new
+me.name # => 'Jerry Chen'
+me.sex # => 'male'
+me.age # => 36
+```
+
+上面的例子确实不太有趣，来个实用点的如何？让我们为 `ActiveRecord` 模型类实现声明式搜索。首先，定义模块：
+
+```ruby
+module Searchable
+
+  extend ActiveSupport::Concern
+
+  included do
+    # 使用 class attribute 保存搜索条件
+    class_attribute :conditions, {}
+  end
+
+  MissileEmitter do |klass, key, *, &block|
+    # 保存声明的每一个关键字，以及搜索算法
+    klass.conditions[key] = block
+  end
+
+  class_methods do
+
+    def search(hash)
+      hash.reduce all do |relation, (key, value)|
+        # Just for fun :)
+        relation = relation.extending do
+          define_method(:_) { value }
+        end
+
+        if value.blank?
+          relation
+        elsif filter = mapping[key]
+          relation.instance_exec(value, &filter)
+        elsif column_names.include?(key)
+          relation.where key => value
+        else
+          relation
+        end
+      end
+    end
+
+  end
+
+end
+```
+
+然后，Mixin 模块：
+
+```ruby
+class Person < ApplicationRecord
+  include Searchable {
+    name_like { |keyword| where 'name like ?', "%#{keyword}%" }
+    older_than { where 'age >= ?', _ }
+  }
+end
+```
+
+最后，在业务代码中使用：
+
+```ruby
+# params: {name: 'Jerry', older_than: 18}
+Person.search params.slice(:name_like, :older_than, :sex)
+# 参数值值不为空的情况下，等价于：
+Person.where('name like ?', "%#{params[:name_like]}%")
+      .where('age >= ?', params[:older_than])
+      .where(sex: params[:sex])
+```
+
+总而言之，使用导弹发射器之后，可以很方便的在类定义级别实现声明式DSL，具体怎么用，就留给你自己慢慢挖掘啦。

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 "missile_emitter"
+
+# 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/missile_emitter/battle_field.rb

@@ -0,0 +1,15 @@
+module MissileEmitter
+  class BattleField < BasicObject
+
+    def initialize(context, callable)
+      @context, @handler = context, callable
+    end
+
+    def method_missing(*args, &block)
+      @handler.call @context, *args, &block
+    end
+
+    alias_method :emit!, :instance_eval
+
+  end
+end

data/lib/missile_emitter/version.rb

@@ -0,0 +1,3 @@
+module MissileEmitter
+  VERSION = "0.1.1"
+end

data/lib/missile_emitter.rb

@@ -0,0 +1,47 @@
+require "missile_emitter/version"
+require "missile_emitter/battle_field"
+
+require "pry" rescue nil
+
+module MissileEmitter
+
+  class Error < StandardError; end
+
+  @mapping = {}
+
+  class << self
+    attr_accessor :mapping
+
+    def exec(&block)
+      raise Error.new("需要提供代码块") unless block_given?
+
+      context = block.binding.eval 'self'
+
+      raise Error.new("只能再具名模块中调用") unless context.instance_of?(Module) && context.name
+
+      mimic_method context
+
+      mapping[context] = block
+    end
+
+    private
+
+    def mimic_method(context)
+      # TODO：处理多层命名空间的情况
+      Kernel.define_method context.name do |&missile|
+        klass = missile.binding.eval 'self'
+        battle_field = BattleField.new klass, MissileEmitter.mapping[context]
+        battle_field.emit! &missile
+
+        context
+      end
+    end
+  end
+
+end
+
+module Kernel
+  def MissileEmitter(&block)
+    MissileEmitter.exec &block
+  end
+end

data/missile_emitter.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "missile_emitter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "missile_emitter"
+  spec.version       = MissileEmitter::VERSION
+  spec.authors       = ["coding-class.com"]
+  spec.email         = ["code@coding-class.com"]
+
+  spec.summary       = %q{Ruby元编程辅助工具}
+  spec.description   = %q{Ruby元编程小工具，让你能在类定义（class definition）级别触发 method_missing 事件，同时不用担心潜在的命名冲突。 }
+  spec.homepage      = "https://github.com/coding-class-club/missile_emitter"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/coding-class-club/missile_emitter"
+  spec.metadata["changelog_uri"] = "https://github.com/coding-class-club/missile_emitter/blob/master/CHANGELOG.md"
+
+  # 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", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: missile_emitter
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- coding-class.com
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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: 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'
+description: 'Ruby元编程小工具，让你能在类定义（class definition）级别触发 method_missing 事件，同时不用担心潜在的命名冲突。 '
+email:
+- code@coding-class.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/missile_emitter.rb
+- lib/missile_emitter/battle_field.rb
+- lib/missile_emitter/version.rb
+- missile_emitter.gemspec
+homepage: https://github.com/coding-class-club/missile_emitter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/coding-class-club/missile_emitter
+  source_code_uri: https://github.com/coding-class-club/missile_emitter
+  changelog_uri: https://github.com/coding-class-club/missile_emitter/blob/master/CHANGELOG.md
+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.6
+signing_key: 
+specification_version: 4
+summary: Ruby元编程辅助工具
+test_files: []