yard_dizby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38e0d02941eb44a86376a1556587a07f66b1ae9b
+  data.tar.gz: ee96e81c3e6371327971b6e2f12903fb00222f72
+SHA512:
+  metadata.gz: 220eae725bebaa08c7d120be04dc0880687fc4d9335380baef8ac7fb3c97c9403d72eed844f25ee001147c873d604503d2f673105a811eadba28e870603f5103
+  data.tar.gz: 242ed88b762c79b649d859730831149c5db54faa10e6ae32f8c3b6596348c11446556ec49f445a490a604f08ae2753450b8132e5cacacde2d61f9665c76ba51b

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+
+*.gem
+/pkg/
+
+.rubocop-*

data/.rubocop.yml

@@ -0,0 +1,47 @@
+---
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 12
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/AutoResourceCleanup:
+  Enabled: true
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/Copyright:
+  Enabled: true
+  Notice: '^# Copyright \(c\) 2\d{3} .+$'
+
+Style/Encoding:
+  Enabled: true
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/MultilineArrayBraceLayout:
+  Enabled: true
+
+Style/MultilineAssignmentLayout:
+  Enabled: true
+
+Style/OptionHash:
+  Enabled: true
+
+Style/Send:
+  Enabled: true
+
+Style/StringMethods:
+  Enabled: true
+
+Style/SymbolArray:
+  Enabled: true
+
+Lint/LiteralInInterpolation:
+  Enabled: true

data/Gemfile

@@ -0,0 +1,13 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake', require: false
+
+  # lint
+  gem 'rubocop', '>= 0.36.0', require: false
+end

data/Rakefile

@@ -0,0 +1,17 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup(:default, :development)
+
+require 'bundler/gem_tasks'
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.fail_on_error = false
+end
+task('rubocop:auto_correct').clear
+
+task default: :rubocop

data/lib/yard_dizby/config_access_handler.rb

@@ -0,0 +1,94 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+module YARD
+  module Dizby
+    class ConfigAccessHandler < ::YARD::Handlers::Ruby::AttributeHandler
+      handles method_call(:config_reader)
+      handles method_call(:config_writer)
+      handles method_call(:config_accessor)
+      namespace_only
+
+      def access_permissions
+        case statement.method_name(true)
+        when :config_reader
+          [true, false]
+        when :config_writer
+          [false, true]
+        when :config_accessor
+          [true, true]
+        else
+          [false, false]
+        end
+      end
+
+      def process_impl(method, permission)
+        if permission
+          obj = MethodObject.new(namespace, method, scope)
+          yield obj
+
+          register(obj)
+          obj
+        else
+          namespace.children.find do |o|
+            o.name == method.to_sym && o.scope == scope
+          end
+        end
+      end
+
+      def store_obj(type, name, obj)
+        namespace.attributes[scope][name][type] = obj if obj
+      end
+
+      def signature(obj, sig, src)
+        obj.signature ||= sig
+        obj.source ||= "#{sig}\n#{src}"
+      end
+
+      def process_reader(attribute, permission)
+        final =
+          process_impl(attribute, permission) do |obj|
+            signature(obj, "def #{attribute}", "  @config[:#{attribute}]\nend")
+            if obj.docstring.blank?(false)
+              obj.docstring =
+                "Returns the value of configuration attribute #{attribute}"
+            end
+          end
+
+        store_obj :read, attribute, final
+      end
+
+      def process_writer(attribute, permission)
+        final =
+          process_impl("#{attribute}=", permission) do |obj|
+            obj.parameters = [['value', nil]]
+            signature(obj, "def #{attribute}=(value)",
+                      "  @config[:#{attribute}] = value\nend")
+            obj.docstring = <<-eos if obj.docstring.blank?(false)
+              Sets the configuration attribute #{attribute}
+              @param value the value to set the attribute #{attribute} to.
+            eos
+          end
+
+        store_obj :write, attribute, final
+      end
+
+      def process_access(name)
+        read, write = access_permissions
+        namespace.attributes[scope][name] ||= SymbolHash[read: nil, write: nil]
+
+        process_reader(name, read)
+        process_writer(name, write)
+      end
+
+      def process
+        return if statement.type == :var_ref || statement.type == :vcall
+        params = statement.parameters(false).dup
+
+        validated_attribute_names(params).each do |name|
+          process_access(name)
+        end
+      end
+    end
+  end
+end

data/lib/yard_dizby/rake_overload.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+module YARD
+  module Dizby
+    def self.template_path
+      File.expand_path('../../template', File.dirname(__FILE__))
+    end
+  end
+end
+
+module DizbyYardocTaskExtension
+  def initialize(name = :yard)
+    super(name) do |task|
+      task.options += ['--template-path', YARD::Dizby.template_path]
+      yield task if block_given?
+    end
+  end
+end
+
+YARD::Rake::YardocTask.__send__(:prepend, DizbyYardocTaskExtension)

data/lib/yard_dizby/version.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+module YARD
+  module Dizby
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/yard_dizby.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+require 'yard_dizby/config_access_handler'

data/template/default/layout/html/footer.erb

@@ -0,0 +1,3 @@
+<div id="footer">
+    Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
+</div>

data/yard_dizby.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+require './lib/yard_dizby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yard_dizby'
+  spec.version       = YARD::Dizby::VERSION
+  spec.authors       = ['Nathan Currier']
+  spec.email         = ['nathan.currier@gmail.com']
+  spec.license       = 'BSD-3-clause'
+
+  spec.description   = 'YARD plugin for Dizby'
+  spec.summary       = 'YARD plugin to ease documenting Dizby'
+  spec.homepage      = 'https://github.com/rideliner/yard_dizby'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = 'bin'
+  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_dependency 'yard', '> 0.7'
+  spec.add_dependency 'bundler', '>= 1.11.2'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: yard_dizby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Currier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  name: yard
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  name: bundler
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+description: YARD plugin for Dizby
+email:
+- nathan.currier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Rakefile
+- lib/yard_dizby.rb
+- lib/yard_dizby/config_access_handler.rb
+- lib/yard_dizby/rake_overload.rb
+- lib/yard_dizby/version.rb
+- template/default/layout/html/footer.erb
+- yard_dizby.gemspec
+homepage: https://github.com/rideliner/yard_dizby
+licenses:
+- BSD-3-clause
+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.8
+signing_key: 
+specification_version: 4
+summary: YARD plugin to ease documenting Dizby
+test_files: []
+has_rdoc: