crochets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: fa8f043b2077e645ba3d3cc2ee8e0f5ad357317f
+  data.tar.gz: e7e0aede37071ac4aed8f1e6e3a760e60eda46c6
+!binary "U0hBNTEy":
+  metadata.gz: 1df5f29ebbddc42d4b5566e78defdb76e597e9e6946241e500a45835ede91ef9323f480564da79c2391a225d68a749d13c886bb4410dca4a9d555511bfc82055
+  data.tar.gz: c896fd6e02c80aa6f9b8013f8bf20e5a297a15a3f5b1499f328319fc2ebb21619b6bc4a787bc241ac998ce76af194e1d05f96ab34a65d35c87c88e5323fdf1e1

data/.document

@@ -0,0 +1,11 @@
+# .document is used by rdoc and yard to know how to generate documentation 
+# for example, it can be used to control how rdoc gets built when you do `gem install foo`
+
+README.rdoc
+lib/**/*.rb
+bin/*
+
+# Files below this - are treated as 'extra files', and aren't parsed for ruby code
+- 
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+crochets.komodoproject
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in crochets.gemspec
+gemspec
+
+gem 'aquarium', '~> 0.6.0', :git => 'git://github.com/deanwampler/Aquarium.git'
+
+gem 'rake', :group => :test

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Alexei Matyushkin
+
+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,68 @@
+# Crochets
+
+[![Build Status](https://travis-ci.org/mudasobwa/crochets.png)](https://travis-ci.org/mudasobwa/crochets)
+
+This gem is kinda syntactic sugar for setting hooks on ruby method calls.
+
+It uses [Aquarium](https://github.com/deanwampler/Aquarium) for aspects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'crochets'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crochets
+
+## Usage
+
+The usage is straightforward:
+
+```ruby
+class MyClass
+  def my_method
+    puts "Hello, world!"
+  end
+end
+    
+@aspect = Crochets.hook(MyClass, :my_method, after: true, blocking: false) do |obj, *args|
+  puts "NB: world is now helloed."
+end
+
+# ⇒ Hello, world!
+# ⇒ NB: world is now helloed.
+```
+
+The hook may then be unset:
+
+```ruby
+@aspect.unhook
+```
+    
+There are many hooks on the same method may be set simultaneously. They will be invoked in
+the order they were set.
+
+### Arguments
+
+The method `Crochets::Crocheter#hook` accepts following parameters:
+
+* **object or class** `[Class|Object]` the object or class to set the hook on;
+* **method** `Symbol` the name of the method to set the hook on, or `:all_methods`
+* **after** `[TrueClass|FalseClass]` apply the hook _after_ method body execution
+* **before** `[TrueClass|FalseClass]` apply the hook _before_ method body execution
+* **blocking** `[TrueClass|FalseClass]` when `false`, the hook will be executed in the
+separate thread.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler/setup'
+
+require 'rspec/core/rake_task'
+
+desc 'Tests'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = '-Ispec'
+  # spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+desc 'Cucumber'
+Cucumber::Rake::Task.new(:features)
+
+require 'yard'
+desc 'Yard'
+YARD::Rake::YardocTask.new(:yard) do |t|
+  t.files   = ['**/*.rb', 'features/**/*.feature', 'features/**/*.rb']
+end
+
+task :default => :features

data/crochets.gemspec

@@ -0,0 +1,33 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'crochets/version'
+
+Gem::Specification.new do |s|
+  s.name = 'crochets'
+  s.version = Crochets::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.date = '2013-12-26'
+  s.authors = ['Alexei Matyushkin']
+  s.email = 'am@mudasobwa.ru'
+  s.homepage = 'http://github.com/mudasobwa/crochets'
+  s.summary = %Q{Library to utilize setting hooks on Ruby classes}
+  s.description = %Q{Easy setting of hook chains on Ruby methods calls in rubtime}
+  s.extra_rdoc_files = [
+    'LICENSE',
+    'README.md',
+  ]
+
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.7')
+  s.rubygems_version = '1.3.7'
+  s.specification_version = 3
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'yard-cucumber'
+end
+

data/features/crochets.feature

@@ -0,0 +1,26 @@
+Feature: Crochery built on top of Aquarium Aspects library is working
+  In order to build and use crochets library
+  A user defines hooks and they are called respectively
+
+  Scenario: Check no hook
+    Given The respective aspects are applied
+    When I do not set the hook on tester method
+    Then the hook is not being called
+
+  Scenario: Check hook unsetting
+    Given The respective aspects are applied
+    When I set the hook on tester method
+    And  I unset the hook on tester method
+    Then the hook is not being called
+
+  Scenario: Check hook setting
+    Given The respective aspects are applied
+    When I set the hook on tester method
+    Then the hook is being called
+
+  Scenario: Check non-blocking hook setting
+    Given The respective aspects are applied
+    When I set the non-blocking hook on tester method
+#    And I wait for a while
+    Then the hook is being called
+

data/features/step_definitions/crochets_steps.rb

@@ -0,0 +1,40 @@
+Given(/^The respective aspects are applied$/) do
+  
+end
+
+When(/^I do not set the hook on tester method$/) do
+
+end
+
+When(/^I set the hook on tester method$/) do
+  @aspect = Crochets.hook(Crochets::Tester, :some_method, before: true) do |obj, *args|
+    puts "BLOCKING BEFORE"
+  end
+  @aspect2 = Crochets.hook(Crochets::Tester, :some_method, before: true) do |obj, *args|
+    puts "BLOCKING BEFORE 2"
+  end
+end
+
+When(/^I set the non\-blocking hook on tester method$/) do
+  @aspect = Crochets.hook(Crochets::Tester, :some_method, after: true, blocking: false) do |obj, *args|
+    sleep 1
+    puts "NON-BLOCKING AFTER"
+  end
+end
+
+When(/^I wait for a while$/) do
+  sleep 1
+end
+
+When(/^I unset the hook on tester method$/) do
+  Crochets.unhook @aspect
+end
+
+Then(/^the hook is being called$/) do
+  Crochets::Tester.new.some_method
+end
+
+Then(/^the hook is not being called$/) do
+  Crochets::Tester.new.some_method
+end
+

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+
+require 'crochets'
+
+require 'rspec/expectations'

data/lib/crochets.rb

@@ -0,0 +1,34 @@
+require_relative 'crochets/version'
+require 'aquarium'
+
+module Crochets
+  include Aquarium::DSL
+
+  extend self
+  
+  def hook obj, meth, before: false, after: false, blocking: true, &cb
+    this = Class === obj || object == obj
+    around \
+          :calls_to => meth, \
+          :on_types => (Class === obj ? obj : obj.class), \
+          :method_options => [:public, :protected, :private] \
+      do |join_point, object, *args|
+          blocking ? cb.call(object, *args) : Thread.new { cb.call(object, *args) }\
+            if before && this
+          result = join_point.proceed
+          blocking ? cb.call(object, *args) : Thread.new { cb.call(object, *args) } \
+            if after && this
+          result
+      end if before || after
+  end
+  # Helper method for calling convention consistency
+  def unhook aspect
+    aspect.unadvise unless aspect.nil?
+  end
+  
+  class Tester
+    def some_method
+      p "Some method"
+    end
+  end
+end

data/lib/crochets/version.rb

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

data/spec/crochets_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Crochets do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+
+require 'crochets'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: crochets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexei Matyushkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: yard
+  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: cucumber
+  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: yard-cucumber
+  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: Easy setting of hook chains on Ruby methods calls in rubtime
+email: am@mudasobwa.ru
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .document
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- crochets.gemspec
+- features/crochets.feature
+- features/step_definitions/crochets_steps.rb
+- features/support/env.rb
+- lib/crochets.rb
+- lib/crochets/version.rb
+- spec/crochets_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/mudasobwa/crochets
+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: 1.3.7
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 3
+summary: Library to utilize setting hooks on Ruby classes
+test_files: []
+has_rdoc: