attire 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4631d29300b437d384ef7c0873628c7e133eaff
-  data.tar.gz: 2ce7528a9f0b6ce2a8d919c68637f5f644e2530c
+  metadata.gz: 9e182d55a0029623e5a05e47f92701bbe3fd55e2
+  data.tar.gz: 2d209d7daf659e2bef9e5f7da389641ab0d7c99f
 SHA512:
-  metadata.gz: 21c05ea5b7dd1af7817e4cd41f95c4b6f0740b21b5e20000ce96c129ff77ecb7e84b1442549f604b002d9e5ab180dd7baedcf0b0d5e8ca15da50c9bc28ca686d
-  data.tar.gz: 2f0ff51cda93ad0d1a06c29f304bd869588c0910483ecb21aa1a8709209f3a887e024d0a9a1a476a0bf02f169f20e1832565a1bae95c708134311af4ba801844
+  metadata.gz: 5fa120c1f70fedb9a5a3f93173444bd054269ba6eaa9d9881b5e89b24b39aad1d33abdc25c6c1940138e8d4562a003c87fd4531c5313a9cbbe50bfbded357cf0
+  data.tar.gz: 8b0e10d88064358730c4ff416e5f9f90b56b6fd01a951389651ccb6e205e47528e78b6bf227226d34fec0e0dfe286138384901c4df3e799c0e8ce03a2134a5f2

data/README.md

@@ -3,43 +3,50 @@
 [![Build Status](https://travis-ci.org/mushishi78/attire.svg?branch=master)](https://travis-ci.org/mushishi78/attire)
 [![Gem Version](https://badge.fury.io/rb/attire.svg)](http://badge.fury.io/rb/attire)
 
-Mixins to remove some boiler plate in defining classes.
+Helper to remove some boiler plate in defining classes.
 
-**N.B. This is the README for version 2.0. This release is written for Ruby 2.0 or higher. For previous versions please consult the tagged releases.**
+## Usage
 
-## Initializer
+The `attire` method defines an `initialize` method where all it's parameters are stored as instance variables that can be retrieve with private getters. So a class defined like this:
 
-`Attire::Initializer` extends a subsequent initialize method so that all it's parameters are assigned to instance variables and they can all be reached from private getters. For example:
+```ruby
+class Measurement
+  def initialize(value:, units: :grams)
+    @value = value
+    @units = units
+  end
 
-``` ruby
-require 'attire'
+  def to_s
+    "#{value} (#{units})"
+  end
 
-class MyClass
-  extend Attire::Initializer
+  private
 
-  def initialize(foo:, bar: 24)
-    @bar = bar * 2
-  end
+  attr_reader :value, :units
+end
+```
 
-  def result
-    foo + bar
+Can be shortened to:
+
+```ruby
+require 'attire'
+
+class Measurement
+  attire 'value:, units: :grams'
+
+  def to_s
+    "#{value} (#{units})"
   end
 end
-
-my_instance = MyClass.new(foo: 50)
-my_instance.result # 98
 ```
 
-## MethodObject
+### Method Objects
 
-`Attire::MethodObject` does the same as `Attire::Initializer` but it also adds a singleton method that creates an instance and then calls an instance method of the same name. This is useful for objects that are designed to do one task. For example:
+Sometimes it's useful for objects that are designed to do only a single task to have a class method that both initializes the object and executes the task. For this purpose, `attire` allows you to set the `verb` keyword like so:
 
 ``` ruby
 class CheeseSpreader
-  extend Attire::MethodObject.new(:spread)
-
-  def initialize(cheese, cracker: Jacobs.new)
-  end
+  attire 'cheese, cracker: Jacobs.new', verb: :spread
 
   def spread
     cracker.spreads << cheese

data/lib/attire.rb

@@ -1,2 +1,32 @@
-require 'attire/initializer'
-require 'attire/method_object'
+module Attire
+  def attire(param_str, method: :initialize, verb: nil, &after)
+    names = eval("->(#{param_str}){}").parameters.map(&:last)
+    def_init(param_str, method, names)
+    add_getters(names)
+    define_method(:__after) { instance_exec(&after) if after }
+    def_verb(verb) if verb
+  end
+
+  private
+
+  def def_init(param_str, method, names)
+    class_eval "def #{method}(#{param_str})\n#{ivars(names)}\n__after\nend"
+  end
+
+  def ivars(names)
+    names.map { |name| "@#{name} = #{name}\n" }.join
+  end
+
+  def add_getters(names)
+    attr_reader(*names)
+    private(*names)
+  end
+
+  def def_verb(verb)
+    define_singleton_method(verb) { |*a, **k, &b| new(*a, **k, &b).send(verb) }
+  end
+end
+
+class Module
+  include Attire
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attire
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Max White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-10 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,20 +30,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: contracts
-  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: 
 email: mushishi78@gmail.com
 executables: []
@@ -53,8 +39,6 @@ files:
 - LICENSE.txt
 - README.md
 - lib/attire.rb
-- lib/attire/initializer.rb
-- lib/attire/method_object.rb
 homepage: https://github.com/mushishi78/attire
 licenses:
 - MIT
@@ -78,5 +62,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Mixins to remove some boiler plate in defining classes.
+summary: Helper to remove some boiler plate in defining classes.
 test_files: []

data/lib/attire/initializer.rb

@@ -1,51 +0,0 @@
-module Attire
-  module Initializer
-    def self.extended(base)
-      base.class.instance_variable_set(:@_added, false)
-    end
-
-    def method_added(method_name)
-      return super unless method_name == :initialize && !added?
-
-      self.added = true
-      method = instance_method(:initialize)
-      super
-
-      names = method.parameters.map(&:last)
-      add_initialize(method, names)
-      add_getters(names)
-    end
-
-    private
-
-    def added?
-      self.class.instance_variable_get(:@_added)
-    end
-
-    def added=(added)
-      self.class.instance_variable_set(:@_added, added)
-    end
-
-    def add_initialize(method, names)
-      initialize_line = initialize_line(method)
-      set_ivars = names.map { |name| "@#{name} = #{name}\n" }.join
-
-      initializer = Module.new do
-        class_eval "#{initialize_line}#{set_ivars}super\nend\n"
-      end
-      prepend initializer
-    end
-
-    def initialize_line(method)
-      file, endline = *method.source_location
-      File.readlines(file)[0..endline].reverse.each do |line|
-        return line if line.include?('initialize')
-      end
-    end
-
-    def add_getters(names)
-      attr_reader(*names)
-      private(*names)
-    end
-  end
-end

data/lib/attire/method_object.rb

@@ -1,12 +0,0 @@
-require_relative 'initializer'
-
-module Attire
-  module MethodObject
-    def self.new(verb)
-      Module.new do
-        define_singleton_method(:extended) { |base| base.extend Initializer }
-        define_method(verb) { |*a, **k, &b| new(*a, **k, &b).send(verb) }
-      end
-    end
-  end
-end