ruby_abstract_class 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 145f64b6abc5de6fc89567f545a0fc214231fc6e8128c29bf768502f4499c8d5
+  data.tar.gz: 31e1f052101bd431e58d8f20b6874cc44ecf1967011d4b62f9a3be169fcb71f7
+SHA512:
+  metadata.gz: 50fa05a6deb62b27782fbdb6ff88e63d53275e9cbae9ce512dc2dd7f8ae75d0eba1635d3639c2be9ca72f6fbe4d0f1cdf2d49dd0f086ff96a50a97e17a399635
+  data.tar.gz: bc527ff8191992b74036507cc366921a158816b30c52ff5952bc39da28bf14ef1bb37fa4cb856631a68aca57ea6d3c67fe81295e0c8195a265dfc80cec091b9b

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at cfc9209@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ruby_abstract_class.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    ruby_abstract_class (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.1)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  ruby_abstract_class!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andrey Kozlovskiy
+
+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,76 @@
+# RubyAbstractClass
+
+This gem is going to fix the problem with Polymorphism in Ruby language. You can easily define abstract methods and abstract classes which were, unfortunately, missing in Ruby originally. Now you can define your strategy and allow subclass to implement it. Enjoy and feel free to ask any questions via issues section here in GitHub.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_abstract_class'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ruby_abstract_class
+
+## Usage
+
+To make class abstract you need to include `RubyAbstractClass` module and specify which methods are abstract by `abstract_method` method. Here you go.
+
+```ruby
+class A
+  include RubyAbstractClass
+
+  def foo(_params)
+  end
+  abstract_method :foo # a single method
+
+  abstract_method :bar, :foobar # multiple methods
+
+  abstract_method # just make an abstract class without any abstract methods for now
+end
+
+
+class B < A
+  def foo
+    puts 'foo'
+  end
+
+  def bar
+    puts 'bar'
+  end
+end
+
+B.new.foo # => foo
+B.new.bar # => bar
+
+B.new.foobar # => exception: You must implement B#foobar.
+
+A.new # => exception: You cannot instantiate an instance of Abstract Class `A`.
+```
+
+Thank you :)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby_abstract_class. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ruby_abstract_class/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RubyAbstractClass project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruby_abstract_class/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']                # optional
+  t.options = ['--any', '--extra', '--opts'] # optional
+  t.stats_options = ['--list-undoc']         # optional
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruby_abstract_class"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ruby_abstract_class.rb

@@ -0,0 +1,45 @@
+require 'ruby_abstract_class/version'
+
+# Allow a Ruby class to be an abstract class
+module RubyAbstractClass
+  # :nodoc:
+  def self.included(base)
+    base.extend(AbstractClassMethods)
+  end
+
+  module AbstractClassMethods
+    # :nodoc:
+    def new
+      raise "You cannot instantiate an instance of Abstract Class `#{self}`." if abstract_class?
+
+      super
+    end
+
+    # :nodoc:
+    def allocate
+      raise "You cannot allocate an instance of Abstract Class `#{self}`." if abstract_class?
+
+      super
+    end
+
+    # Tells whether a class is abstract
+    # # @return [Boolean] true or false
+    def abstract_class?
+      @abstract_class == self
+    end
+
+    # Makes class abstract and comma separated methods passed as symbols
+    # abstract_method
+    # abstract_method :foo
+    # abstract_method :foo, :bar
+    def abstract_method(*methods)
+      @abstract_class = self
+
+      methods.each do |method|
+        define_method method do
+          raise NotImplementedError, "You must implement #{self.class}##{__method__}."
+        end
+      end
+    end
+  end
+end

data/lib/ruby_abstract_class/version.rb

@@ -0,0 +1,3 @@
+module RubyAbstractClass
+  VERSION = '0.2.0'
+end

data/ruby_abstract_class.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/ruby_abstract_class/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_abstract_class"
+  spec.version       = RubyAbstractClass::VERSION
+  spec.authors       = ["Andrey Kozlovskiy"]
+  spec.email         = ["cfc9209@gmail.com"]
+
+  spec.summary       = %q{Implementation of Abstract Class in Ruby language.}
+  spec.description   = %q{Help to make a class or a method as abstract.}
+  spec.homepage      = "https://github.com/cfc1020/ruby_abstract_class"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/cfc1020/ruby_abstract_class"
+  spec.metadata["changelog_uri"] = "https://github.com/cfc1020/ruby_abstract_class"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: ruby_abstract_class
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Andrey Kozlovskiy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-22 00:00:00.000000000 Z
+dependencies: []
+description: Help to make a class or a method as abstract.
+email:
+- cfc9209@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby_abstract_class.rb
+- lib/ruby_abstract_class/version.rb
+- ruby_abstract_class.gemspec
+homepage: https://github.com/cfc1020/ruby_abstract_class
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cfc1020/ruby_abstract_class
+  source_code_uri: https://github.com/cfc1020/ruby_abstract_class
+  changelog_uri: https://github.com/cfc1020/ruby_abstract_class
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Implementation of Abstract Class in Ruby language.
+test_files: []