attire 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53a76fd77e586cecce6fea04de34aea4225090d3
+  data.tar.gz: a8e7d3b291bc0adc3845a7d893d4bca319256254
+SHA512:
+  metadata.gz: 66e94421748b69661c57680844088fee92e8474a252b7130e5c6e9918f8f6b16f015746c3b1ce51fa851ac6f561cfd53055ef74efd4e3bbfa27106f7affa8931
+  data.tar.gz: 0efe0cdb17fc8e4903746b983ef0b039b13db70ebb783bbcb732599c9270b43dd604cb14131b9b33292368e1cfc71a48351ce245b84f91c3be209dadb90534f0

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Max White
+
+MIT License
+
+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,88 @@
+# Attire
+
+Convenience methods to remove some boiler plate in defining classes. Heavily inspired by [attr_extras](https://github.com/barsoom/attr_extras).
+
+## Usage
+
+### `attr_init :foo, :bar, fizz: 15, pop: nil`
+
+Defines the following initializer:
+
+``` ruby
+def initializer(foo, bar, opts = {})
+	@foo = foo
+	@bar = bar
+	@fizz = opts[:fizz] || 15
+	@pop = opts[:pop]
+end
+```
+
+`attr_init` can also accept a block which will be invoked after initialization.
+
+### `attr_method :select, :bar`
+
+Shortcut for:
+
+``` ruby
+attr_init :bar
+
+def self.select(bar)
+  new(bar).select
+end
+```
+
+This is useful for method objects/use cases:
+
+``` ruby
+class CheeseSpreader
+  attr_method :spread, :cheese, crackers: Jacobs.new
+
+  def spread
+  	raise CheeseError unless cheese.is_a?(Cheddar)
+  	cheese.spread_on(crackers)
+  end
+end
+
+...
+
+my_cheese = Roquefort.new
+CheeseSpreader.spread(my_cheese) # CheeseError
+```
+
+### `attr_query :foo?`
+
+Defines query methods like `foo?`, which is true if `foo` is truthy.
+
+### `fattr_init :foo`
+
+Calls `self.freeze` after initialization to make object immutable.
+
+### `fattr_method :foo`
+
+Same as `fattr_init`, only for `attr_method`.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attire'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attire
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/attire/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/attire.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attire/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "attire"
+  spec.version       = Attire::VERSION
+  spec.authors       = ["Max White"]
+  spec.email         = ["mushishi78@gmail.com"]
+  spec.summary       = %q{Convenience methods to remove some boiler plate in defining classes.}
+  spec.homepage      = "https://github.com/mushishi78/attire"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'rspec', '~> 3.1'
+end

data/lib/attire/attr_init.rb

@@ -0,0 +1,76 @@
+module Attire
+  class AttrInit
+    def self.apply(*args)
+      new(*args).apply
+    end
+
+    def initialize(klass, args, block)
+      @klass, @args, @block = klass, args, block
+    end
+
+    def apply
+      type_check
+      init = method(:init)
+      klass.send(:define_method, :initialize) { |*values| init.call(self, values) }
+      define_getters
+    end
+
+    private
+
+    attr_reader :klass, :args, :block, :instance, :values
+
+    def init(instance, values)
+      @instance, @values = instance, values
+      arity_check
+      set_variables
+      instance.instance_eval(&block) if block
+    end
+
+    def set_variables
+      args.zip(values).each do |arg, value|
+        next set_variable(arg, value) if arg.is_a?(Symbol)
+        value = {} if value.nil?
+        hash_check(value)
+        arg.each { |k, v| set_variable(k, value[k] || v) }
+      end
+    end
+
+    def define_getters
+      getter_names.each do |arg|
+        klass.send(:define_method, arg) { instance_variable_get("@#{arg}") }
+        klass.send(:private, arg)
+      end
+    end
+
+    def type_check
+      return if args.all? {|a| [Symbol, Hash].include?(a.class) }
+      fail ArgumentError, 'Must be Symbol or Hash.'
+    end
+
+    def arity_check
+      return if arity_range.include?(values.length)
+      fail ArgumentError, "wrong number of arguments (#{values.length} for #{arity_range})"
+    end
+
+    def hash_check(value)
+      return if value.is_a?(Hash)
+      fail ArgumentError, "#{value} should be Hash."
+    end
+
+    def min_arity
+      args.last.is_a?(Hash) ? args.length - 1 : args.length
+    end
+
+    def arity_range
+      @arity_range ||= (min_arity..args.length)
+    end
+
+    def set_variable(name, value)
+      instance.instance_variable_set("@#{name}", value)
+    end
+
+    def getter_names
+      args.map { |arg| arg.respond_to?(:keys) ? arg.keys : arg }.flatten
+    end
+  end
+end

data/lib/attire/version.rb

@@ -0,0 +1,3 @@
+module Attire
+  VERSION = "0.0.1"
+end

data/lib/attire.rb

@@ -0,0 +1,37 @@
+require 'attire/version'
+require 'attire/attr_init'
+
+module Attire
+  def attr_query(*names)
+    names.each do |name|
+      name = name.to_s
+      fail ArgumentError, "`#{name}?`, not `#{name}`." unless name.end_with?("?")
+      define_method(name) { !!send(name.chop) }
+    end
+  end
+
+  def attr_init(*args, &b)
+    AttrInit.apply(self, args, b)
+  end
+
+  def attr_method(verb, *args, &b)
+    define_singleton_method(verb) { |*a| new(*a).send(verb) }
+	  attr_init(*args, &b)
+	end
+
+	def fattr_init(*args, &b)
+    attr_init(*args) do
+    	instance_eval(&b) if b
+    	self.freeze
+    end
+  end
+
+  def fattr_method(verb, *args, &b)
+    define_singleton_method(verb) { |*a| new(*a).send(verb) }
+	  fattr_init(*args, &b)
+	end
+end
+
+class Module
+	include Attire
+end

data/spec/attr_init_spec.rb

@@ -0,0 +1,47 @@
+describe '#attr_init' do
+  let(:instance) { define_class(inside).new(1, 2, option1: 54) }
+  let(:inside) do
+    Proc.new { attr_init :argument1, :argument2, option1: 23, option2: 'default', option3: nil }
+  end
+
+  it 'assigns arguments to private methods' do
+    expect(instance.send(:argument1)).to eq(1)
+    expect(instance.send(:argument2)).to eq(2)
+    expect(instance.send(:option1)).to eq(54)
+    expect(instance.send(:option2)).to eq('default')
+    expect(instance.send(:option3)).to eq(nil)
+  end
+
+  context 'with optional hash missing' do
+  	let(:instance) { define_class(inside).new(1, 2) }
+
+	  it 'still assigns arguments to private methods using default' do
+	    expect(instance.send(:option1)).to eq(23)
+	  end
+  end
+
+  context 'with input of wrong type' do
+  	let(:inside) { Proc.new { attr_init 'Strings bad' } }
+    it { expect { define_class(inside) }.to raise_error(ArgumentError) }
+  end
+
+  context 'with too many arguments' do
+    let(:instance) { define_class(inside).new(1, 2, {}, 4, 5) }
+    it { expect { instance }.to raise_error(ArgumentError) }
+  end
+
+  context 'with too few arguments' do
+    let(:instance) { define_class(inside).new(1) }
+    it { expect { instance }.to raise_error(ArgumentError) }
+  end
+
+  context 'with block' do
+    let(:instance) { define_class(inside).new(1) }
+    let(:inside) { Proc.new { attr_init :foo do @foo = 5 end } }
+
+    it 'calls block' do
+      expect(instance.send(:foo)).to eq(5)
+    end
+  end
+end
+

data/spec/attr_method_spec.rb

@@ -0,0 +1,16 @@
+describe '#attr_method' do
+  let(:klass) do
+    klass = Class.new do
+      attr_method :select, :child, toy: 5
+
+      def select
+        toy * child
+      end
+    end
+  end
+
+  it 'creates a class method that initializes and calls instance method' do
+    expect(klass.select(3)).to eq(15)
+    expect(klass.select(3, toy: 2)).to eq(6)
+  end
+end

data/spec/attr_query_spec.rb

@@ -0,0 +1,19 @@
+describe '#attr_query' do
+  context 'with correct arguments' do
+    let(:instance) { define_class(inside).new }
+    let(:inside) do
+      Proc.new { attr_accessor :foo; attr_query :foo? }
+    end
+
+    it 'creates a query method' do
+      expect(instance.foo?).to be(false)
+      instance.foo = 'rah'
+      expect(instance.foo?).to be(true)
+    end
+  end
+
+  context 'without a tailing questionmark' do
+    let(:inside) { Proc.new { attr_query :bar } }
+    it { expect { define_class(inside) }.to raise_error }
+  end
+end

data/spec/fattr_spec.rb

@@ -0,0 +1,17 @@
+describe '#fattr_init' do
+  let(:instance) { define_class(inside).new(5) }
+  let(:inside) { Proc.new { fattr_init :chick } }
+
+  it 'freezes class after initializing' do
+    expect(instance.send(:chick)).to eq(5)
+    expect { instance.instance_variable_set('@chick', 12) }.to raise_error
+  end
+
+  context 'with block' do
+    let(:inside) { Proc.new { fattr_init :chick do @chick = 15 end } }
+    it 'still evaluates block' do
+      expect(instance.send(:chick)).to eq(15)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'attire'
+
+def define_class(proc)
+  Class.new { instance_eval(&proc) }
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: attire
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Max White
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: 
+email:
+- mushishi78@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- attire.gemspec
+- lib/attire.rb
+- lib/attire/attr_init.rb
+- lib/attire/version.rb
+- spec/attr_init_spec.rb
+- spec/attr_method_spec.rb
+- spec/attr_query_spec.rb
+- spec/fattr_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mushishi78/attire
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Convenience methods to remove some boiler plate in defining classes.
+test_files:
+- spec/attr_init_spec.rb
+- spec/attr_method_spec.rb
+- spec/attr_query_spec.rb
+- spec/fattr_spec.rb
+- spec/spec_helper.rb