simple_annotation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25158c07a27196aeecc5db4f08c8af0129f2485f5dab1184b14338a956f3284a
+  data.tar.gz: d412eb711e99836174a3d5c82b3ae44f4a1c9d02c1483f1c0836130ff67c3baf
+SHA512:
+  metadata.gz: cac55700c541f2b9270181480c0eec12b80135da7b20d379a895469ac596d98ded201355fc8576cb405f43eb9565add697098fb24cab9067ec14f177d7f511c0
+  data.tar.gz: e0d53db327d871e5e264f0eb511c7fc63218d48d12163ac2f670c386feb6d5b20af2ab7e7c03709c3ef1eb2886b4a3cf95411a1d98ecf99697176f4485aeb7a2

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.15
+        bundle install
+        bundle exec rake

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-06-12
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_annotation.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'test-unit', '~> 3.0'
+
+gem 'rubocop', '~> 1.7'

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    simple_annotation (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    power_assert (2.0.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.16.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    test-unit (3.4.4)
+      power_assert
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  simple_annotation!
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+  test-unit (~> 3.0)
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Tomohiro Nishimura
+
+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,73 @@
+# SimpleAnnotation
+
+Annotate method with anything. Symbol, String and so on.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_annotation'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install simple_annotation
+
+## Usage
+
+### Basic style
+
+```ruby
+class A
+  include SimpleAnnotation::Annotatable
+
+  def meth; end
+end
+
+A.annotated?(:meth) #=> false
+
+# Annotate method with :example
+A.annotates(:meth, with: :example)
+
+A.annotated?(:meth, with: :example) #=> true
+A.annotations(:meth) #=> [:example]
+
+A.public_instance_method(:meth).annotations #=> [:example]
+A.new.method(:meth).annotations #=> [:example]
+```
+
+### Separate line style
+
+```ruby
+class A
+  include SimpleAnnotation::Annotatable
+
+  annotates 'this is a annotation'
+  def meth; end
+end
+
+A.annotated?(:meth, with: 'this is a annotation') #=> true
+A.annotations(:meth) #=> ['this is a annotation']
+
+A.public_instance_method(:meth).annotations #=> ['this is a annotation']
+A.new.method(:meth).annotations #=> ['this is a annotation']
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` 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 the created tag, 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/Sixeight/simple_annotation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'simple_annotation'
+
+# 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/simple_annotation.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'simple_annotation/version'
+require_relative 'simple_annotation/annotatable'
+
+module SimpleAnnotation
+  def annotations
+    return [] unless owner.include? Annotatable
+
+    owner.annotations(original_name)
+  end
+
+  ::UnboundMethod.include self
+  ::Method.include self
+end

data/lib/simple_annotation/annotatable.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module SimpleAnnotation
+  module Annotatable
+    def self.included(mod)
+      mod.instance_variable_set(:@__method_to_annotations, Hash.new { |h, k| h[k] = Set.new })
+      mod.instance_variable_set(:@__standby_annotations, [])
+      mod.extend ClassMethods
+    end
+
+    module ClassMethods
+      def annotates(*method_or_annotations, with: nil)
+        if with.nil?
+          @__standby_annotations.concat(method_or_annotations)
+        else
+          method_or_annotations.each do |meth|
+            @__method_to_annotations[meth.to_sym] << with
+          end
+        end
+      end
+
+      def annotated?(meth, with: nil)
+        return @__method_to_annotations.include?(meth.to_sym) if with.nil?
+
+        @__method_to_annotations[meth.to_sym].include? with
+      end
+
+      def annotations(meth)
+        @__method_to_annotations[meth.to_sym].to_a
+      end
+
+      private
+
+      def method_added(meth)
+        super
+
+        @__standby_annotations.each do |annotation|
+          annotates meth, with: annotation
+        end
+        @__standby_annotations.clear
+      end
+    end
+  end
+end

data/lib/simple_annotation/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleAnnotation
+  VERSION = '0.1.0'
+end

data/simple_annotation.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'lib/simple_annotation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_annotation'
+  spec.version       = SimpleAnnotation::VERSION
+  spec.authors       = ['Tomohiro Nishimura']
+  spec.email         = ['tomohiro68@gmail.com']
+
+  spec.summary       = 'Annotate method with anything.'
+  spec.description   = 'Annotate method with anything. Symbol, String and so on'
+  spec.homepage      = 'https://githuc.com/Sixeight/simple_annotation'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = format('%s/blob/master/CHANGELOG.md', spec.homepage)
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: simple_annotation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomohiro Nishimura
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-12 00:00:00.000000000 Z
+dependencies: []
+description: Annotate method with anything. Symbol, String and so on
+email:
+- tomohiro68@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_annotation.rb
+- lib/simple_annotation/annotatable.rb
+- lib/simple_annotation/version.rb
+- simple_annotation.gemspec
+homepage: https://githuc.com/Sixeight/simple_annotation
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://githuc.com/Sixeight/simple_annotation
+  source_code_uri: https://githuc.com/Sixeight/simple_annotation
+  changelog_uri: https://githuc.com/Sixeight/simple_annotation/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Annotate method with anything.
+test_files: []