takes_macro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac45871868bf22d2b8c236ec68de72f8a86f01e0f69b6e96c1b6ebbdff41f4b5
+  data.tar.gz: ba98c96f8568e1b0eb15a43c96479079bfa1829d42a1b1039bc78d6fea8ada78
+SHA512:
+  metadata.gz: 9458d509d6fd5161941b876eaf640b73701ecec94a865fe6b124ba8a1414f215ede66b6f83fddd97eef48361925011ef5273a38449cecdb17283a006fb891f50
+  data.tar.gz: 219daeaef444a0a9b2dbb1b7d2c0d72279fa1f5d6d78d86fa8ee3abecb94e880a8ac73c75358de3c8cd497b06af7a7e46ffda195f85d963b5cb4f8bbd4ee5107

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in takes_macro.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    takes_macro (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    attr_extras (5.2.0)
+    benchmark-ips (2.7.2)
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  attr_extras (~> 5.2.0)
+  benchmark-ips (~> 2.7.2)
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  takes_macro!
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,154 @@
+# TakesMacro
+
+[attr_extras][] is a **great** gem that lets you remove most of the boilerplate needed for creating different types of initializers in Ruby.
+
+This gem contains a reimplementation of `pattr_initialize` from attr_extras that is much faster. If you're using attr_extras, but the only feature of it you're using is `pattr_initialize` then this gem is for you.
+
+This gem calls the method `takes` to avoid confusing, but the API is exactly the same.
+
+## Benchmark
+
+Run `bundle exec ruby benchmarks/takes_macro_vs_attr_extras.rb` to see how much faster this gem is. The output from doing that on my machine is:
+
+    $ bundle exec ruby benchmarks/takes_macro_vs_attr_extras.rb
+    Warming up --------------------------------------
+             attr_extras    15.793k i/100ms
+                 takes_macro    91.596k i/100ms
+    hand written initializer
+                            71.351k i/100ms
+    Calculating -------------------------------------
+             attr_extras    169.353k (± 3.9%) i/s -    852.822k in   5.043680s
+                 takes_macro      1.209M (± 4.5%) i/s -      6.045M in   5.011814s
+    hand written initializer
+                            875.721k (± 5.8%) i/s -      4.424M in   5.071249s
+
+    Comparison:
+                       takes_macro:  1208748.5 i/s
+      hand written initializer:   875721.1 i/s - 1.38x  slower
+                   attr_extras:   169352.8 i/s - 7.14x  slower
+
+## How it works
+
+This gem expands this
+
+```ruby
+class A
+  takes [:foo!]
+end
+```
+
+Into this
+
+```ruby
+class A
+  def initialize(options)
+    @foo = options.fetch(:foo)
+  end
+
+  attr_reader :foo
+  private :foo
+end
+```
+
+It does that by looking at the arguments to `takes` and from that building a `String` of Ruby code that it will then `class_eval`. That means calling `takes` is literally as fast as writing the initializer by hand. Nothing fancy happens when you call `A.new(...)`.
+
+### Possible arguments to `takes`
+
+You can call `takes` in many different ways depending on the style of initializer you want. Here are the different styles and what they expand into:
+
+#### Positional args
+
+```ruby
+takes :foo, :bar
+
+def initialize(foo, bar)
+  @foo = foo
+  @bar = bar
+end
+```
+
+#### Required keyword args
+
+```ruby
+takes [:foo!, :bar!]
+
+def initialize(foo:, bar:)
+  @foo = foo
+  @bar = bar
+end
+```
+
+#### Optional keyword args
+
+```ruby
+takes [:foo, :bar]
+
+def initialize(foo: nil, bar: nil)
+  @foo = foo
+  @bar = bar
+end
+```
+
+#### Mixed positional, required and optional keyword args
+
+```ruby
+takes :foo, [:bar!, :baz]
+
+def initialize(foo, bar:, baz: nil)
+  @foo = foo
+  @bar = bar
+  @baz = baz
+end
+```
+
+__Note:__ Each instance variable set in the initializer also gets a private `attr_reader`, but that was left out of the examples for clarity.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "takes_macro"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install takes_macro
+
+## Usage
+
+If you want to use `takes` in all your classes add this to your app:
+
+```ruby
+require "takes_macro"
+
+TakesMacro.monkey_patch_object
+```
+
+If you're in a Rails app I recommend adding this to `config/application.rb` so you're sure to have it in all your classes.
+
+That will include the `TakesMacro` module, which defines the `takes` method, on `Object`.
+
+If you don't like monkey patching `Object` you can still do this:
+
+```ruby
+require "takes_macro"
+
+class A
+  include TakesMacro
+
+  takes [:foo!, :bar!, :baz!]
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+[attr_extras]: https://github.com/barsoom/attr_extras

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/benchmarks/takes_macro_vs_attr_extras.rb

@@ -0,0 +1,41 @@
+require "benchmark/ips"
+require "attr_extras"
+require "takes_macro"
+
+class A
+  pattr_initialize :a, [:b!, :c]
+end
+
+TakesMacro.monkey_patch_object
+
+class B
+  takes :a, [:b!, :c]
+end
+
+class C
+  def initialize(a, b:, c: nil)
+    @a = a
+    @b = b
+    @c = c
+  end
+
+  private
+
+  attr_reader :a, :b, :c
+end
+
+Benchmark.ips do |x|
+  x.report("attr_extras") do
+    A.new(:a, b: :b)
+  end
+
+  x.report("takes_macro") do
+    B.new(:a, b: :b)
+  end
+
+  x.report("hand written initializer") do
+    C.new(:a, b: :b)
+  end
+
+  x.compare!
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "takes_macro"
+
+# 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/takes_macro.rb

@@ -0,0 +1,75 @@
+require "takes_macro/version"
+
+module TakesMacro
+  def self.monkey_patch_object
+    Object.send(:include, TakesMacro)
+  end
+
+  def takes(*args)
+    positional_args = args.reject { |arg| arg.is_a?(Array) }
+    keyword_args = if args.last.is_a?(Array)
+                     args.last.map(&:to_s)
+                   else
+                     []
+                   end
+    all_args = (positional_args + keyword_args).flatten.map do |arg|
+      arg.to_s.delete("!")
+    end
+
+    args_code = [
+      positional_args,
+    ]
+
+    if keyword_args.any?
+      args_code << "options"
+    end
+
+    args_code = args_code.flatten.compact.join(", ")
+
+    bind_positional_args_code = positional_args.map do |arg|
+      "@#{arg} = #{arg}"
+    end.join("\n")
+
+    bind_keywords_args_code = keyword_args.map do |arg|
+      code = if arg =~ /!$/
+        arg = arg.delete("!")
+        "@#{arg} = options.fetch(:#{arg})"
+      else
+        "@#{arg} = options[:#{arg}]"
+      end
+      [code, "options.delete(:#{arg})"].join("\n")
+    end.join("\n")
+
+    define_private_attr_readers_code = all_args.map do |arg|
+      <<-RUBY
+        attr_reader :#{arg}
+        private :#{arg}
+      RUBY
+    end.join("\n")
+
+    ensure_options_are_empty =
+      if keyword_args.any?
+        <<-EOS
+          unless options == {}
+            raise ArgumentError, "Not all initialize args were used: \#{options.keys.inspect}"
+          end
+        EOS
+      else
+        ""
+      end
+
+    code = <<-RUBY
+      def initialize(#{args_code})
+        #{bind_positional_args_code}
+        #{bind_keywords_args_code}
+        #{ensure_options_are_empty}
+        after_takes
+      end
+      #{define_private_attr_readers_code}
+
+      def after_takes; end
+    RUBY
+
+    class_eval code
+  end
+end

data/lib/takes_macro/version.rb

@@ -0,0 +1,3 @@
+module TakesMacro
+  VERSION = "0.1.0"
+end

data/takes_macro.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "takes_macro/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "takes_macro"
+  spec.version       = TakesMacro::VERSION
+  spec.authors       = ["David Pedersen"]
+  spec.email         = ["david@tonsser.com"]
+
+  spec.summary       = %q{Remove boilerplate for writing initializers}
+  spec.description   = %q{A faster implementation of `pattr_initialize` from the attr_extras gem}
+  spec.homepage      = "https://github.com/tonsser/takes_macro"
+
+  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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "benchmark-ips", "~> 2.7.2"
+  spec.add_development_dependency "attr_extras", "~> 5.2.0"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: takes_macro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Pedersen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+- !ruby/object:Gem::Dependency
+  name: attr_extras
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+description: A faster implementation of `pattr_initialize` from the attr_extras gem
+email:
+- david@tonsser.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- benchmarks/takes_macro_vs_attr_extras.rb
+- bin/console
+- bin/setup
+- lib/takes_macro.rb
+- lib/takes_macro/version.rb
+- takes_macro.gemspec
+homepage: https://github.com/tonsser/takes_macro
+licenses: []
+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: Remove boilerplate for writing initializers
+test_files: []