yard-mongoid 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d87056112075d7dbdd92fb12adeef56d88794bc2
+  data.tar.gz: 57b081ecc357b9acafc0de8e6c2ebc3e78fefb1e
+SHA512:
+  metadata.gz: d12700f677cbe7e4d78d8450df5ff87a816231ee58a9d3aa552f9df00de252a1d572db78b26884661ee9ada767abb52018e116145040c83a050948b7ee84127b
+  data.tar.gz: 14efe78f104eccf5247bd9a4761a3c2e3caf98eeb9ba3440066ee3cd6b38ec839dc9441d9c54b0593f100fb077591a02f3f4f5114a2cb6aa825a21b52045907d

data/.gitignore

@@ -2,3 +2,5 @@ pkg/*
 *.gem
 .bundle
 Gemfile.lock
+.ruby-version
+.idea

data/Gemfile

@@ -2,12 +2,3 @@ source 'http://rubygems.org'
 
 # Specify your gem's dependencies in yard-mongoid.gemspec
 gemspec
-
-group :development do
-  gem 'rake'
-  gem 'mongoid', '~> 3.0'
-  gem 'yard-activerecord' # Needed for some code examples
-  gem 'yard-activerecord2' # Needed for some code examples
-  gem 'yard-rails' # Needed for some code examples
-  gem 'yard-delegate' # Needed for some code examples
-end

data/README.md

@@ -0,0 +1,58 @@
+# YARD::Mongoid
+
+[![Gem Version](https://badge.fury.io/rb/yard-mongoid.svg)][gem]
+[![Build Status](https://secure.travis-ci.org/alsemyonov/yard-mongoid.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/alsemyonov/yard-mongoid.svg)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/alsemyonov/yard-mongoid/badges/gpa.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/alsemyonov/yard-mongoid/badges/coverage.svg)][coverage]
+
+A [YARD](https://rubygems.org/gems/yard) plugin for documenting [Mongoid](https://rubygems.org/gems/mongoid) models. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yard-mongoid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yard-mongoid
+
+## Usage
+
+Add following line to `.yardopts`:
+
+```
+--plugin mongoid
+```
+
+or use it as argument to `yard doc` command like `yard doc --plugin mongoid`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 `bin/rake install`. To release a new version, update the version number in `version.rb`, and then run `bin/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/alsemyonov/yard-mongoid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+© [Alex Semyonov](https://al.semyonov.us/) <[alex@semyonov.us](mailto:alex@semyonov.us?subject=yard-mongoid)>, 2016
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[gem]: https://rubygems.org/gems/yard-mongoid
+[travis]: https://travis-ci.org/alsemyonov/yard-mongoid
+[gemnasium]: https://gemnasium.com/alsemyonov/yard-mongoid
+[codeclimate]: https://codeclimate.com/github/alsemyonov/yard-mongoid
+[coverage]: https://codeclimate.com/github/alsemyonov/yard-mongoid/coverage

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'yard-mongoid'
+
+require 'pry'
+Pry.start

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/yard/handlers/ruby/mongoid/extensions.rb

@@ -1,7 +1,8 @@
 module YARD::Handlers::Ruby
   module Mongoid
     module Extensions
-    protected
+      protected
+
       def effected_namespace
         if statement.type == :command_call
           context = statement.jump(:var_ref)

data/lib/yard/handlers/ruby/mongoid/field_handler.rb

@@ -8,7 +8,7 @@ module YARD::Handlers::Ruby
       include Extensions
       include YARD::Handlers::Ruby::Mongoid::Helpers
 
-      MONGOID_FIELDS = 'Fields'
+      MONGOID_FIELDS = 'Fields'.freeze
 
       namespace_only
 
@@ -22,11 +22,11 @@ module YARD::Handlers::Ruby
 
           add_field_getter(effected_namespace, name, class_name, default_value)
           add_field_setter(effected_namespace, name, class_name)
-          #register_field_presence(effected_namespace, name, scope)
-          #register_field_change(effected_namespace, name, scope)
-          #register_field_changed(effected_namespace, name, scope)
-          #register_field_was(effected_namespace, name, scope)
-          #register_field_reset(effected_namespace, name, scope)
+          # register_field_presence(effected_namespace, name, scope)
+          # register_field_change(effected_namespace, name, scope)
+          # register_field_changed(effected_namespace, name, scope)
+          # register_field_was(effected_namespace, name, scope)
+          # register_field_reset(effected_namespace, name, scope)
         end
       end
 
@@ -38,7 +38,7 @@ module YARD::Handlers::Ruby
         if statement.parameters.size > 2
           statement.parameters[1].source.split(/,\s*/).each do |key_and_value|
             if key_and_value =~ hash_args[:type]
-              @class_name = $2
+              @class_name = Regexp.last_match(2)
               break
             end
           end
@@ -53,7 +53,7 @@ module YARD::Handlers::Ruby
         if statement.parameters.size > 2
           statement.parameters[1].source.split(/,\s*/).each do |key_and_value|
             if key_and_value =~ /(:default\s*=>|default:)\s*(.+)\s*$/
-              @default_value = $2
+              @default_value = Regexp.last_match(2)
               break
             end
           end
@@ -70,7 +70,7 @@ module YARD::Handlers::Ruby
       end
 
       # @yieldparam [YARD::CodeObjects::MethodObject]
-      def add_field_method(namespace, name, &block)
+      def add_field_method(namespace, name)
         register YARD::CodeObjects::MethodObject.new(namespace, name, :instance) do |mo|
           mo.group = MONGOID_FIELDS
           mo.visibility ||= :public
@@ -78,7 +78,7 @@ module YARD::Handlers::Ruby
           mo.dynamic = true
           mo.signature = "def #{name}"
           mo.docstring = '' if mo.docstring.empty?
-          block.call(mo) if block_given?
+          yield(mo) if block_given?
         end
       end
 

data/lib/yard/handlers/ruby/mongoid/helpers.rb

@@ -8,7 +8,7 @@ module YARD
           # @param [Symbol] tag
           # @param [String] text
           # @param [String] return_classes
-          def get_tag(tag, text, return_classes = [], name=nil)
+          def get_tag(tag, text, return_classes = [], name = nil)
             YARD::Tags::Tag.new(tag, text, [return_classes].flatten, name)
           end
         end

data/lib/yard/handlers/ruby/mongoid/relations/base.rb

@@ -15,7 +15,7 @@ module YARD::Handlers::Ruby::Mongoid
         object.group     = group_name
         object.docstring = return_description
         object.docstring.add_tag get_tag(:return, '', class_name)
-        object.docstring.add_tag get_tag(:see, "http://mongoid.org/en/mongoid/docs/relations.html##{statement.method_name(true).to_s}")
+        object.docstring.add_tag get_tag(:see, "http://mongoid.org/en/mongoid/docs/relations.html##{statement.method_name(true)}")
         object.dynamic = true
         register object
       end
@@ -25,6 +25,7 @@ module YARD::Handlers::Ruby::Mongoid
       end
 
       private
+
       def method_name
         call_params[0]
       end
@@ -36,7 +37,7 @@ module YARD::Handlers::Ruby::Mongoid
           while i < param_size - 1
             # May want to evaluate doing it this way
             statement.parameters[i].jump(:hash).source =~ /(:class_name\s*=>|class_name:)\s*["']([^"']+)["']/
-            return $2 if $2
+            return Regexp.last_match(2) if Regexp.last_match(2)
             i += 1
           end
         end

data/lib/yard/handlers/ruby/mongoid/relations/belongs_to_handler.rb

@@ -9,6 +9,7 @@ module YARD::Handlers::Ruby::Mongoid::Relations
     end
 
     private
+
     def return_description
       ''
     end

data/lib/yard/handlers/ruby/mongoid/relations/has_and_belongs_to_many_handler.rb

@@ -9,6 +9,7 @@ module YARD::Handlers::Ruby::Mongoid::Relations
     end
 
     private
+
     def return_description
       ''
     end

data/lib/yard/handlers/ruby/mongoid/relations/has_many_handler.rb

@@ -9,6 +9,7 @@ module YARD::Handlers::Ruby::Mongoid::Relations
     end
 
     private
+
     def return_description
       ''
     end

data/lib/yard/handlers/ruby/mongoid/relations/has_one_handler.rb

@@ -9,6 +9,7 @@ module YARD::Handlers::Ruby::Mongoid::Relations
     end
 
     private
+
     def return_description
       ''
     end

data/lib/yard/handlers/ruby/mongoid/relations/plural_handler.rb

@@ -7,6 +7,7 @@ module YARD::Handlers::Ruby::Mongoid::Relations
     end
 
     private
+
     def return_description
       "An array of associated #{method_name.humanize}"
     end

data/lib/yard/handlers/ruby/mongoid/relations/singular_handler.rb

@@ -7,6 +7,7 @@ module YARD::Handlers::Ruby::Mongoid::Relations
     end
 
     private
+
     def return_description
       "An associated {#{method_name.humanize}}"
     end

data/lib/yard/mongoid/version.rb

@@ -1,5 +1,5 @@
-module Yard
+module YARD
   module Mongoid
-    VERSION = '0.0.3'
+    VERSION = '0.1.0'.freeze
   end
 end

data/yard-mongoid.gemspec

@@ -1,23 +1,25 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'yard/mongoid/version'
 
 Gem::Specification.new do |s|
-  s.name        = 'yard-mongoid'
-  s.version     = Yard::Mongoid::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Alexander Semyonov']
-  s.email       = %w(al@semyonov.us)
-  s.homepage    = 'http://rubygems.org/gems/yard-mongoid'
-  s.summary     = %q{A Yard plugin for parsing Mongoid model syntax.}
-  s.description = %q{Once yard-mongoid is installed, YARD will automatically load the plugin when ever the `yard doc` utility is ran on a project.}
+  s.name = 'yard-mongoid'
+  s.version     = YARD::Mongoid::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Alexander Semyonov']
+  s.email = %w(al@semyonov.us)
+  s.homepage = 'http://rubygems.org/gems/yard-mongoid'
+  s.summary = 'A Yard plugin for parsing Mongoid model syntax.'
+  s.description = 'Once yard-mongoid is installed, YARD will automatically load the plugin when ever the `yard doc` utility is ran on a project.'
 
-  s.rubyforge_project = 'yard-mongoid'
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.bindir = 'exe'
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = %w(lib)
 
-  s.add_dependency 'yard', '~> 0.8.4'
+  s.add_runtime_dependency 'yard', '>= 0.8.4'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'mongoid', '>= 3.0'
+  s.add_development_dependency 'pry'
 end

metadata

@@ -1,32 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: yard-mongoid
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Alexander Semyonov
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2013-03-08 00:00:00.000000000 Z
+date: 2016-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Once yard-mongoid is installed, YARD will automatically load the plugin
   when ever the `yard doc` utility is ran on a project.
 email:
@@ -35,10 +74,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - MIT-LICENSE
+- README.md
 - Rakefile
+- bin/console
+- bin/rake
+- bin/setup
 - lib/yard-mongoid.rb
 - lib/yard/handlers/ruby/mongoid/extensions.rb
 - lib/yard/handlers/ruby/mongoid/field_handler.rb
@@ -55,27 +98,25 @@ files:
 - yard-mongoid.gemspec
 homepage: http://rubygems.org/gems/yard-mongoid
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: yard-mongoid
-rubygems_version: 1.8.23
+rubyforge_project: 
+rubygems_version: 2.5.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Yard plugin for parsing Mongoid model syntax.
 test_files: []
-has_rdoc: