abstractize 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: a5321d951d788f9141096c9f78a04ee1811cc880
4
+ data.tar.gz: 0062e725d0708f50d675d8592448206481276a10
5
+ SHA512:
6
+ metadata.gz: 3abe687cd43e2a2f0d672629e22b1e6d3cc77d3adcfd19b275883b3dda203ba314de7c0218f3fd92dded9f8c364985321b4810fd9c2c93f69d12c75508f0aa22
7
+ data.tar.gz: 1351b9ef4841384f2ce8c95f0f389606050e5bfd46c76f2f0436170501365deb46fed8be8147e498a2cfa6db2ef302ad60c1e2d35baac514959fd365b31da97e
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ 2.2.0
data/.travis.yml ADDED
@@ -0,0 +1,3 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.1
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in abstract.gemspec
4
+ gemspec
data/MIT-LICENSE ADDED
@@ -0,0 +1,19 @@
1
+ Copyright (c) 2015 Joakim Reinert
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy of
4
+ this software and associated documentation files (the "Software"), to deal in
5
+ the Software without restriction, including without limitation the rights to
6
+ use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
7
+ of the Software, and to permit persons to whom the Software is furnished to do
8
+ so, subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice shall be included in all
11
+ copies or substantial portions of the Software.
12
+
13
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,83 @@
1
+ # Abstractize
2
+
3
+ A simple mixin for abstract class functionality in ruby
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'abstractize'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install abstract
20
+
21
+ ## Usage
22
+
23
+ ``` ruby
24
+ require 'abstractize'
25
+
26
+ class Vehicle
27
+ include Abstractize
28
+
29
+ attr_reader :wheels, :mileage
30
+ def initialize(wheels=4)
31
+ @mileage = 0
32
+ @wheels = wheels
33
+ end
34
+
35
+ define_abstract_method :drive
36
+ end
37
+ ```
38
+
39
+ ``` ruby
40
+ class Car < Vehicle
41
+ end
42
+ ```
43
+
44
+ ``` ruby
45
+ class Tricycle < Vehicle
46
+ def initialize
47
+ super(3)
48
+ end
49
+
50
+ def drive
51
+ @mileage += 0.01
52
+ end
53
+ end
54
+ ```
55
+
56
+ ``` ruby
57
+ vehicle = Vehicle.new(2)
58
+ # AbstractError: cannot instanciate Vehicle
59
+ car = Car.new
60
+ # => #<Car:0x007f5e130631f0 @mileage=0, @wheels=4>
61
+ car.drive
62
+ # AbstractError: not implemented
63
+ tricycle = Tricycle.new
64
+ # => #<Tricycle:0x007f5e13093148 @mileage=0, @wheels=3>
65
+ tricycle.drive
66
+ # => 0.01
67
+ tricycle.drive
68
+ # => 0.02
69
+ ```
70
+
71
+ ## Development
72
+
73
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
74
+
75
+ 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
76
+
77
+ ## Contributing
78
+
79
+ 1. Fork it ( https://github.com/[my-github-username]/abstract/fork )
80
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
81
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
82
+ 4. Push to the branch (`git push origin my-new-feature`)
83
+ 5. Create a new Pull Request
data/Rakefile ADDED
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+
@@ -0,0 +1,29 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'abstractize/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'abstractize'
8
+ spec.version = Abstractize::VERSION
9
+ spec.authors = ['Joakim Reinert']
10
+ spec.email = ['mail@jreinert.com']
11
+
12
+ spec.metadata['allowed_push_host'] = 'https://rubygems.org' if spec.respond_to?(:metadata)
13
+
14
+ spec.summary = 'Simple mixin to provide abstract class functionality'
15
+ spec.homepage = 'https://github.com/jreinert/abstractize'
16
+ spec.license = 'MIT'
17
+
18
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
19
+ f.match(/^(test|spec|features)\//)
20
+ end
21
+ spec.executables = spec.files.grep(/^exe\//) { |f| File.basename(f) }
22
+ spec.require_paths = ['lib']
23
+
24
+ spec.add_development_dependency 'bundler', '~> 1.8'
25
+ spec.add_development_dependency 'rake', '~> 10.0'
26
+ spec.add_development_dependency 'rspec', '~> 3.2'
27
+ spec.add_development_dependency 'simplecov', '~> 0.9'
28
+ spec.add_development_dependency 'pry-byebug', '~> 3.0'
29
+ end
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'abstractize'
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require 'irb'
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,2 @@
1
+ class AbstractError < RuntimeError
2
+ end
@@ -0,0 +1,3 @@
1
+ module Abstractize
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,33 @@
1
+ require 'abstractize/version'
2
+ require 'abstractize/abstract_error'
3
+
4
+ # Mixin for abstract classes
5
+ module Abstractize
6
+ def self.included(base)
7
+ (class << base; self; end).instance_eval do
8
+ define_method(:new, Abstractize.abstract_new(base))
9
+ define_method(:define_abstract_method, Abstractize.abstract_method)
10
+ end
11
+ end
12
+
13
+ protected
14
+
15
+ def abstract_new(base)
16
+ lambda do |*args|
17
+ instance = super(*args)
18
+ fail AbstractError, "cannot instanciate #{name}" if self == base
19
+ instance
20
+ end
21
+ end
22
+
23
+ def abstract_method
24
+ lambda do |name|
25
+ define_method(name) do
26
+ fail AbstractError, 'not implemented'
27
+ end
28
+ end
29
+ end
30
+
31
+ module_function :abstract_new
32
+ module_function :abstract_method
33
+ end
metadata ADDED
@@ -0,0 +1,129 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: abstractize
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Joakim Reinert
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2015-03-16 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.8'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.8'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.2'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.2'
55
+ - !ruby/object:Gem::Dependency
56
+ name: simplecov
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '0.9'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '0.9'
69
+ - !ruby/object:Gem::Dependency
70
+ name: pry-byebug
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '3.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '3.0'
83
+ description:
84
+ email:
85
+ - mail@jreinert.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".ruby-version"
93
+ - ".travis.yml"
94
+ - Gemfile
95
+ - MIT-LICENSE
96
+ - README.md
97
+ - Rakefile
98
+ - abstractize.gemspec
99
+ - bin/console
100
+ - bin/setup
101
+ - lib/abstractize.rb
102
+ - lib/abstractize/abstract_error.rb
103
+ - lib/abstractize/version.rb
104
+ homepage: https://github.com/jreinert/abstractize
105
+ licenses:
106
+ - MIT
107
+ metadata:
108
+ allowed_push_host: https://rubygems.org
109
+ post_install_message:
110
+ rdoc_options: []
111
+ require_paths:
112
+ - lib
113
+ required_ruby_version: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ required_rubygems_version: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: '0'
123
+ requirements: []
124
+ rubyforge_project:
125
+ rubygems_version: 2.4.5
126
+ signing_key:
127
+ specification_version: 4
128
+ summary: Simple mixin to provide abstract class functionality
129
+ test_files: []