yard-sequel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 073ce59843dbdb8f357321e2deabfa0b201c064d
+  data.tar.gz: 1797e658e7baa1ef8fa21aa58bac9f45c9ec2958
+SHA512:
+  metadata.gz: a29270319e1ed42d99f0d90658a525b704568831f59d35ed70a10b551e45db5f497294b7e073b0c45c1dc3c360d4d9dd30e2da9529dd576c55ec151d5cd8b2ef
+  data.tar.gz: 5543778bc9c3d94c1f1aace225bd0707cf40e6661a8b76ca209e7109e8c6620046b4ed4917c11abd345797d3ba3d9691607dcdbf6ec39dd89ea588171d7969f2

data/.yardopts

@@ -0,0 +1,5 @@
+--title "YARD Sequel Plugin"
+--no-private
+--protected
+--markup markdown
+lib/**/*.rb

data/lib/yard-sequel.rb

@@ -0,0 +1,20 @@
+require 'sequel'
+require 'yard'
+
+Sequel.extension :inflector
+
+# The YARD base module
+module YARD
+  # The YARD handlers module
+  module Handlers
+    # The module for YARD ruby handlers
+    module Ruby
+      # Module for documenting Sequel code.
+      # @author Kai Moschcau
+      module Sequel
+      end
+    end
+  end
+end
+
+require_relative 'yard-sequel/associations'

data/lib/yard-sequel/associations.rb

@@ -0,0 +1,18 @@
+module YARD
+  module Handlers
+    module Ruby
+      module Sequel
+        # Module for documention Sequel associations.
+        # @author Kai Moschcau
+        module Associations
+        end
+      end
+    end
+  end
+end
+
+require_relative 'associations/association_handler'
+require_relative 'associations/mixins'
+
+require_relative 'associations/many_to_one_handler'
+require_relative 'associations/one_to_many_handler'

data/lib/yard-sequel/associations/association_handler.rb

@@ -0,0 +1,101 @@
+module YARD
+  module Handlers
+    module Ruby
+      module Sequel
+        module Associations
+          # The basic method handler class for Sequel associations.
+          # @author Kai Moschcau
+          class AssociationHandler < YARD::Handlers::Ruby::MethodHandler
+            protected
+
+            # Adds a parameter tag to a method object.
+            # @param [YARD::CodeObjects::MethodObject] method
+            #   The method to add the parameter tag to.
+            # @param [String] name The name of the parameter.
+            # @param [String] class_name The class name of the parameter.
+            # @param [String] description The description of the parameter.
+            # @return [void]
+            def add_param_tag(method, name, class_name, description)
+              method.parameters << [name, nil]
+              method.docstring.add_tag(
+                YARD::Tags::Tag.new(
+                  :param,
+                  description,
+                  class_name,
+                  name
+                )
+              )
+            end
+
+            # @return [String] the name of the association
+            def association_name
+              @statement.parameters.first.jump(:ident).source
+            end
+
+            # @param [String] name The name of the method object.
+            # @return [YARD::CodeObjects::MethodObject] a method object.
+            def create_method_object(name)
+              method = YARD::CodeObjects::MethodObject.new(
+                namespace,
+                name
+              )
+              register_and_tag(method)
+              method
+            end
+
+            # Sets or replaces the return tag on a passed method object.
+            # @param (see #void_return_tag)
+            # @param [String] class_name The class name of the return value.
+            # @param [String] description The description of the return value.
+            # @return (see #void_return_tag)
+            def return_tag(method, class_name, description)
+              method.docstring.delete_tags(:return)
+              method.docstring.add_tag(
+                YARD::Tags::Tag.new(
+                  :return,
+                  description,
+                  class_name
+                )
+              )
+            end
+
+            # Sets or replaces the return tag on a passed method object with a
+            # void return tag.
+            # @param [YARD::CodeObjects::MethodObject] method
+            #   The method object to set the return tag on.
+            # @return [void]
+            def void_return_tag(method)
+              method.docstring.delete_tags(:return)
+              method.docstring.add_tag(
+                YARD::Tags::Tag.new(
+                  :return,
+                  nil,
+                  'void'
+                )
+              )
+            end
+
+            private
+
+            # Registers the source of a given method object and sets some tags.
+            # @param [YARD::CodeObjects::MethodObject] method
+            #   The method object to register and tag.
+            # @return [void]
+            def register_and_tag(method)
+              unless method.is_a? YARD::CodeObjects::MethodObject
+                raise(
+                  ArgumentError,
+                  'The given method has to be a '\
+                  "#{YARD::CodeObjects::MethodObject}"
+                )
+              end
+              register(method)
+              method.dynamic  = true
+              method[:sequel] = :association
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yard-sequel/associations/many_to_one_handler.rb

@@ -0,0 +1,26 @@
+module YARD
+  module Handlers
+    module Ruby
+      module Sequel
+        module Associations
+          # The handler class for Sequel many_to_one associations.
+          # @author Kai Moschcau
+          class ManyToOneHandler < AssociationHandler
+            include YARD::Handlers::Ruby::Sequel::Associations::DatasetMethod
+            include YARD::Handlers::Ruby::Sequel::Associations::ToOneMethods
+
+            handles method_call(:many_to_one)
+            namespace_only
+
+            process do
+              create_to_one_getter
+              create_to_one_setter
+
+              create_dataset_method
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yard-sequel/associations/mixins.rb

@@ -0,0 +1,3 @@
+require_relative 'mixins/dataset_method'
+require_relative 'mixins/to_many_methods'
+require_relative 'mixins/to_one_methods'

data/lib/yard-sequel/associations/mixins/dataset_method.rb

@@ -0,0 +1,25 @@
+module YARD
+  module Handlers
+    module Ruby
+      module Sequel
+        module Associations
+          # Provides methods for creating the dataset method object.
+          # @author Kai Moschcau
+          module DatasetMethod
+            # @return [YARD::CodeObjects::MethodObject] the dataset method
+            #   object.
+            def create_dataset_method
+              method = create_method_object("#{association_name}_dataset")
+              return_tag(
+                method,
+                'Sequel::Dataset',
+                'the association\'s dataset.'
+              )
+              method
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yard-sequel/associations/mixins/to_many_methods.rb

@@ -0,0 +1,78 @@
+module YARD
+  module Handlers
+    module Ruby
+      module Sequel
+        module Associations
+          # Provides methods for creating the to_many method objects.
+          # @author Kai Moschcau
+          module ToManyMethods
+            # @return [YARD::CodeObjects::MethodObject] the to_many adder method
+            #   object.
+            def create_to_many_adder
+              name             = association_name
+              method           = create_method_object("add_#{name.singularize}")
+              method.docstring += "Associates the passed #{name.classify} "\
+                                  'with `self`.'
+              add_param_tag(
+                method,
+                name.singularize,
+                name.classify,
+                "The #{name.classify} to associate with `self`."
+              )
+              return_tag(
+                method,
+                name.classify,
+                "the associated #{name.classify}."
+              )
+              method
+            end
+
+            # @return [YARD::CodeObjects::MethodObject] the to_many clearer
+            #   method object.
+            def create_to_many_clearer
+              name             = association_name
+              method           = create_method_object("remove_all_#{name}")
+              method.docstring += 'Removes the association of all '\
+                                  "#{name.classify.pluralize} with `self`."
+              void_return_tag(method)
+              method
+            end
+
+            # @return [YARD::CodeObjects::MethodObject] the to_many getter
+            #   method object.
+            def create_to_many_getter
+              name   = association_name
+              method = create_method_object(name)
+              return_tag(
+                method,
+                "Array<#{name.classify}>",
+                "the associated #{name.classify.pluralize}."
+              )
+              method
+            end
+
+            # @return [YARD::CodeObjects::MethodObject] the to_many remover
+            #   method object.
+            def create_to_many_remover
+              name             = association_name
+              method           = create_method_object(
+                "remove_#{name.singularize}"
+              )
+              method.docstring += 'Removes the association of the passed '\
+                                  "#{name.classify} with `self`."
+              add_param_tag(
+                method,
+                name.singularize,
+                name.classify,
+                "The #{name.classify} to remove the association with `self` "\
+                'from.'
+              )
+              void_return_tag(method)
+              method
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yard-sequel/associations/mixins/to_one_methods.rb

@@ -0,0 +1,47 @@
+module YARD
+  module Handlers
+    module Ruby
+      module Sequel
+        module Associations
+          # Provides methods for creating the to_one method objects.
+          # @author Kai Moschcau
+          module ToOneMethods
+            # @return [YARD::CodeObjects::MethodObject] the to_one getter method
+            #   object.
+            def create_to_one_getter
+              name   = association_name
+              method = create_method_object(name)
+              return_tag(
+                method,
+                name.classify,
+                "the associated #{name.classify}."
+              )
+              method
+            end
+
+            # @return [YARD::CodeObjects::MethodObject] the to_one setter method
+            #   object.
+            def create_to_one_setter
+              name             = association_name
+              method           = create_method_object("#{name}=")
+              method.docstring += "Associates the passed #{name.classify} "\
+                                  'with `self`.'
+              add_param_tag(
+                method,
+                name,
+                name.classify,
+                "The #{name.classify} to associate with `self`."
+              )
+              return_tag(
+                method,
+                name.classify,
+                "the associated #{name.classify}."
+              )
+              method
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yard-sequel/associations/one_to_many_handler.rb

@@ -0,0 +1,28 @@
+module YARD
+  module Handlers
+    module Ruby
+      module Sequel
+        module Associations
+          # The handler class for Sequel one_to_many associations.
+          # @author Kai Moschcau
+          class OneToManyHandler < AssociationHandler
+            include YARD::Handlers::Ruby::Sequel::Associations::DatasetMethod
+            include YARD::Handlers::Ruby::Sequel::Associations::ToManyMethods
+
+            handles method_call(:one_to_many)
+            namespace_only
+
+            process do
+              create_to_many_adder
+              create_to_many_clearer
+              create_to_many_getter
+              create_to_many_remover
+
+              create_dataset_method
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yard-sequel/version.rb

@@ -0,0 +1,22 @@
+module YARD
+  module Handlers
+    module Ruby
+      module Sequel
+        # The major version number.
+        # Used for changes that are not backwards compatible.
+        V_MAJOR = 0
+
+        # The minor version number.
+        # Used for changes that are backwards compatible.
+        V_MINOR = 1
+
+        # The build version number.
+        # Used for internal changes.
+        V_BUILD = 0
+
+        # The version of the Sequel models.
+        VERSION = Gem::Version.new("#{V_MAJOR}.#{V_MINOR}.#{V_BUILD}")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: yard-sequel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kai Moschcau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.41'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.41'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: This gem provides automatic YARD documentation for theSequel Gem.
+email: kai.moschcau@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- lib/yard-sequel.rb
+- lib/yard-sequel/associations.rb
+- lib/yard-sequel/associations/association_handler.rb
+- lib/yard-sequel/associations/many_to_one_handler.rb
+- lib/yard-sequel/associations/mixins.rb
+- lib/yard-sequel/associations/mixins/dataset_method.rb
+- lib/yard-sequel/associations/mixins/to_many_methods.rb
+- lib/yard-sequel/associations/mixins/to_one_methods.rb
+- lib/yard-sequel/associations/one_to_many_handler.rb
+- lib/yard-sequel/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Provides automatic YARD documentation for Sequel Gem
+test_files: []