ruby-augmentations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 672f337c5e16c31f99be94b1870e3ea4c1118abe
+  data.tar.gz: 8bed552c8bc95e822bc35741c9abc2f8a76e5cdd
+SHA512:
+  metadata.gz: 35b213e53a42a18eeb6c1d738732aa776c85c1d08946b11cbee663b3a0a436fef5bbbd3300cdf9ed9c9cfd6ee7a090adf6959f9c5f7ca1c8a8fdab36b6062920
+  data.tar.gz: 7b173f717b1649f706fc9afa2d39a3439243da45c617b0d868e9b2eb015126e749909df834f572f1c1bb1a72c6854e152aba2d4b452b4f573b1857c418a1fd66

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michael Cizl
+
+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,109 @@
+# Augmentations
+
+*Augmentations* is a tiny gem to easily extend a class with instance methods and class methods, as well as running class methods like Rails `belongs_to` at extend time.
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-augmentations', require: 'augmentations'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-augmentations
+
+And put a require statement into your code:
+
+```ruby
+require 'augmentations'
+```
+
+# Usage
+
+It's basically like `include`ing a module, but you can define class methods and call class methods as you would in the class itself, without (ab)using the `self.included` hook and thus with less boilerplate.
+
+Use it for Rails like
+
+    class User < ActiveRecord::Base
+      augment Shared::Pingable, User::PasswordResetExtension
+    end
+
+with modules like
+
+    module User::PasswordResetExtension
+      augmentation do
+
+        has_many :password_resets
+
+        def self.a_class_method
+          # …
+        end
+
+        def an_instance_method
+          # …
+        end
+
+      end
+    end
+
+This particular module would be found in `app/models/user/password_reset_extension.rb`.
+
+You may pass options to the augmentation as in the following example (taken from [henrik/augmentations.rb](https://gist.github.com/henrik/1281a6f3f6a9632886fa)):
+
+    module MyMod
+      augmentation do |excited: false|
+        attr_accessor :this_works
+        
+        def self.class_method; "this works"; end
+        def instance_method; "this works"; end
+        
+        # Parameters!
+        if excited
+          def self.hi
+            puts "Hi!!!"
+          end
+        else
+          def self.hi
+            puts "Hi."
+          end
+        end
+      end
+    end
+    
+    class MyClass
+      augment MyMod
+    end
+    
+    class MyExcitedClass
+      augment MyMod, excited: true
+    end
+
+## Credits
+
+By [Henrik Nyh](http://henrik.nyh.se/) for [DanceJam](http://dancejam.com) under the MIT license:
+
+Copyright (c) 2008 Henrik Nyh
+
+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/augmentations.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'augmentations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-augmentations"
+  spec.version       = Augmentations::VERSION
+  spec.authors       = ["Michael Cizl"]
+  spec.email         = ["michael@mic-city.de"]
+
+  spec.summary       = %q{Gemified version of Henrik Nyh's augmentations}
+  spec.homepage      = "https://github.com/mcizl/augmentations"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/augmentations.rb

@@ -0,0 +1,3 @@
+require "augmentations/version"
+require "augmentations/object"
+require "augmentations/module"

data/lib/augmentations/module.rb

@@ -0,0 +1,10 @@
+# "Augmentations" plugin for Rails.
+# By Henrik Nyh <http://henrik.nyh.se> under the MIT license for DanceJam <http://dancejam.com> 2008-09-10.
+# See README for usage.
+# By Henrik Nyh 2015-04-02 under the MIT license.
+
+class ::Module
+  def augmentation(**opts, &block)
+    @augmentation ||= block
+  end
+end

data/lib/augmentations/object.rb

@@ -0,0 +1,10 @@
+# "Augmentations" plugin for Rails.
+# By Henrik Nyh <http://henrik.nyh.se> under the MIT license for DanceJam <http://dancejam.com> 2008-09-10.
+# See README for usage.
+# By Henrik Nyh 2015-04-02 under the MIT license.
+
+class ::Object
+  def self.augment(*mods, **opts)
+    mods.each { |mod| class_exec **opts, &mod.augmentation }
+  end
+end

data/lib/augmentations/version.rb

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

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: ruby-augmentations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Cizl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-23 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: 
+email:
+- michael@mic-city.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.txt
+- README.md
+- augmentations.gemspec
+- lib/augmentations.rb
+- lib/augmentations/module.rb
+- lib/augmentations/object.rb
+- lib/augmentations/version.rb
+homepage: https://github.com/mcizl/augmentations
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Gemified version of Henrik Nyh's augmentations
+test_files: []