yard-activesupport-concern 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17cabe4df50f23e68b4d014361ef3fd2e0def52f
+  data.tar.gz: 5f206dfaf1986e8746ecbfbd3a4d4babe129063c
+SHA512:
+  metadata.gz: 1c7075dcd996f4345299f4e7c1776db7882e4bfc2a4e22d25508b04fab9d98a48549805fd8887c7c520a969d6ff50a713e04c05a7de5c05cf85b36136ed91f97
+  data.tar.gz: 76da86df5d55fdf525431c22eb11c08b0a5c3ae14a4ae026b3cbb82d9548a9e351e052ccbe91435a91fa3b3409099dbd34d6b5a9682ce080728cb511d9b8af8f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yard-activesupport-concern.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 digital cuisine
+
+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,61 @@
+# YARD ActiveSupport::Concern Plugin
+
+[![Version](http://img.shields.io/gem/v/yard-activesupport-concern.svg?style=flat-square)](https://rubygems.org/gems/yard-activesupport-concern)
+[![Downloads](http://img.shields.io/gem/dt/yard-activesupport-concern.svg?style=flat-square)](https://rubygems.org/gems/yard-activesupport-concern)
+[![Open Github issues](http://img.shields.io/github/issues/digitalcuisine/yard-activesupport-concern.svg?style=flat-square)](https://github.com/digitalcuisine/yard-activesupport-concern/issues)
+
+This is a [YARD](https://github.com/lsegal/yard) extension that brings support for modules making use of `ActiveSupport::Concern` (very frequent in Rails projects). Here's an example of such module:
+
+```ruby
+module M
+  extend ActiveSupport::Concern
+
+  included do
+    # @!method disabled
+    # @!scope class
+    # @return [Collection<Model>] Return a scope to get all disabled records
+    scope :disabled, -> { where(disabled: true) }
+  end
+
+  class_methods do
+    # A quick way to get all published records
+    # @return [Collection<Model>] Return a scope to get all published records
+    def published
+      where(published: true)
+    end
+  end
+end
+```
+
+Because `ActiveSupport::Concern` moves method/attributes/... definitions inside `included` or `class_methods` blocks, YARD cannot document them out of the box. As a result, the docstrings in the above example won't show in the generated documentation.  
+For many, one workaround has been to move all comments above the `included` or `class_methods` blocks. But this decouples the comments from the actual method definitions and hence defeats the purpose of commenting your code.
+
+This plugin is here to set this right and make YARD aware of those nested definitions.
+
+## Installation
+
+Add the following line to your Gemfile:
+
+```ruby
+gem 'yard-activesupport-concern'
+```
+
+Or install the gem globally:
+
+`gem install yard-activesupport-concern`
+
+You can then use the plugin using the `--plugin activesupport-concern` command-line option or by instructing YARD to always load all available plugins: `yard config load_plugins true` (see [the docs](http://www.rubydoc.info/gems/yard/YARD/Config#load_plugins-class_method))
+
+If you're using a `.yardopts` file, just add the `--plugin activesupport-concern` option to it.
+
+That's it!
+
+
+## License
+
+This plugin is released under the MIT license. Please refer to the [LICENSE](https://github.com/digitalcuisine/yard-activesupport-concern/blob/master/LICENSE) file.
+
+
+## Contributing
+
+Please refer to Github's [guide](https://guides.github.com/activities/contributing-to-open-source/#contributing) to efficiently contribute to this project!

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/yard-activesupport-concern.rb

@@ -0,0 +1,40 @@
+require 'yard-activesupport-concern/version'
+require 'yard'
+
+module YARD
+  module ActiveSupport
+    module Concern
+
+      class IncludedHandler < YARD::Handlers::Ruby::Base
+        handles method_call(:included)
+        namespace_only
+
+        # Process any found `included` block within a "namespace" scope (class
+        # or module).
+        def process
+          # `statement.last.last` refers to the statements within the block
+          # given to `included`. YARD will parse those and attach any generated
+          # documentation to the current namespace at the instance level (unless
+          # overridden with a @!scope directive)
+          parse_block(statement.last.last, namespace: namespace, scope: :instance)
+        end
+      end
+
+      class ClassMethodsHandler < YARD::Handlers::Ruby::Base
+        handles method_call(:class_methods)
+        namespace_only
+
+        # Process any found `class_methods` block within a "namespace" scope
+        # (class or module).
+        def process
+          # `statement.last.last` refers to the statements within the block
+          # given to `class_methods`. YARD will parse those and attach any
+          # generated documentation to the current namespace at the class
+          # level (unless overridden with a @!scope directive)
+          parse_block(statement.last.last, namespace: namespace, scope: :class)
+        end
+      end
+
+    end
+  end
+end

data/lib/yard-activesupport-concern/version.rb

@@ -0,0 +1,7 @@
+module YARD
+  module ActiveSupport
+    module Concern
+      VERSION = '0.0.1'
+    end
+  end
+end

data/yard-activesupport-concern.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yard-activesupport-concern/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yard-activesupport-concern'
+  spec.version       = YARD::ActiveSupport::Concern::VERSION
+  spec.authors       = ['Olivier Lance @ Digital cuisine']
+  spec.email         = ['olivier@digitalcuisine.fr']
+  spec.summary       = %q{A YARD plugin to handle modules using ActiveSupport::Concern}
+  spec.description   = %q{This is a YARD extension that brings support for modules making use of ActiveSupport::Concern. It makes YARD parse docstrings inside included and class_methods blocks and generate the proper documentation for them.}
+  spec.homepage      = 'https://github.com/digitalcuisine/yard-activesupport-concern'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'yard', '>= 0.8'
+
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: yard-activesupport-concern
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Olivier Lance @ Digital cuisine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: This is a YARD extension that brings support for modules making use of
+  ActiveSupport::Concern. It makes YARD parse docstrings inside included and class_methods
+  blocks and generate the proper documentation for them.
+email:
+- olivier@digitalcuisine.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/yard-activesupport-concern.rb
+- lib/yard-activesupport-concern/version.rb
+- yard-activesupport-concern.gemspec
+homepage: https://github.com/digitalcuisine/yard-activesupport-concern
+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.5
+signing_key: 
+specification_version: 4
+summary: A YARD plugin to handle modules using ActiveSupport::Concern
+test_files: []
+has_rdoc: