webgen 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c19662fd022a762e3796811586f073028780d7631922f6ade3c930d14b7b05e0
-  data.tar.gz: 341981393076fbea3fbc4ea77bebd907c622de58243910638cc46539960786cc
+  metadata.gz: 0c2b90d29a4e3ddf583052496505ee5e903beac7a460c2b9fb19180540fe8e59
+  data.tar.gz: '06109f7ce0df6dce4095287907be396c816fcaf8f3c26767420f41af80a00965'
 SHA512:
-  metadata.gz: 662b03ce9694fff8130e39b1f36e6efbb63c0da37c4c8cde291ee91ae48f2a35791c19e3502a8e7d49354ff2f90636fca9de993b84567e52857c27c949a30c48
-  data.tar.gz: bf93a18ede7b162597b1224de51b757156ec818b506c05620cf4aee403a14ac48b1b529ad5e9538d9a534d2cb1923d72f07241eaca6af56628635d19700ed997
+  metadata.gz: e4bc1e38d4cb27cbaeeda92b0775f65a44c8c4a048b4da6c661f8b502a9fe031b5d8476e62a9811f383be1c8dd152a3b59ed31e7466d116d02acf984d39c8184
+  data.tar.gz: '08e4498259a4e83f7623729082637f9ef7a8f78912d07808e65a62aa498cf672149c71a368bf909a80e62d45432ac844f9ae710a754304d451133e6431da8e02'

data/VERSION

@@ -1 +1 @@
-1.6.0
+1.7.0

data/lib/webgen/path_handler/api.rb

@@ -47,8 +47,9 @@ module Webgen
           klass_node = create_page_node_for_class(path, dir_node, klass, output_flag_file)
           api.class_nodes[klass.full_name] = klass_node
           klass_node.node_info[:api] = api
-          klass.each_method {|method| create_fragment_node_for_method(path, klass_node, method)}
-          klass.each_attribute {|attr| create_fragment_node_for_method(path, klass_node, attr)}
+          create_fragment_nodes_for_constants(path, klass_node, klass)
+          create_fragment_nodes_for_attributes(path, klass_node, klass)
+          create_fragment_nodes_for_methods(path, klass_node, klass)
         end
 
         rdoc.store.all_files.sort.each do |file|
@@ -179,13 +180,76 @@ module Webgen
       end
       protected :create_page_node_for_class
 
+      # Creates fragment nodes for constants under the "Constants" fragment.
+      def create_fragment_nodes_for_constants(api_path, klass_node, klass)
+        return if klass.constants.none? {|const| const.display? }
+        constants_url = "#{klass_node.alcn}#Constants"
+        path = Webgen::Path.new(constants_url,
+                                {'handler' => 'copy', 'modified_at' => api_path['modified_at'],
+                                 'pipeline' => [], 'no_output' => true, 'title' => "Constants"})
+        const_node = @website.ext.path_handler.create_secondary_nodes(path).first
+        klass.constants.sort_by(&:name).each do |const|
+          create_fragment_node_for_constant(api_path, const_node, const)
+        end
+      end
+      protected :create_fragment_nodes_for_constants
+
+      # Create a fragment node for the given constant.
+      #
+      # A link definition entry for the method is also created.
+      def create_fragment_node_for_constant(api_path, parent_node, constant)
+        constant_url = "#{parent_node.alcn.sub(/#.*$/, '')}##{constant.name}"
+        path = Webgen::Path.new(constant_url,
+                                {'handler' => 'copy', 'modified_at' => api_path['modified_at'],
+                                 'parent_alcn' => parent_node.alcn,
+                                 'pipeline' => [], 'no_output' => true, 'title' => constant.name})
+        @website.ext.path_handler.create_secondary_nodes(path)
+        add_link_definition(api_path, constant.full_name, constant_url, constant.full_name)
+      end
+      protected :create_fragment_node_for_constant
+
+      # Creates fragment nodes for attributes under the "Attributes" fragment.
+      def create_fragment_nodes_for_attributes(api_path, parent_node, klass)
+        return if klass.attributes.none? {|attr| attr.display? }
+        attributes_url = "#{parent_node.alcn}#Attributes"
+        path = Webgen::Path.new(attributes_url,
+                                {'handler' => 'copy', 'modified_at' => api_path['modified_at'],
+                                  'parent_alcn' => parent_node.alcn,
+                                 'pipeline' => [], 'no_output' => true, 'title' => "Attributes"})
+        attr_node = @website.ext.path_handler.create_secondary_nodes(path).first
+        klass.attributes.sort_by(&:name).each do |attribute|
+          create_fragment_node_for_method(api_path, attr_node, attribute)
+        end
+      end
+      protected :create_fragment_nodes_for_attributes
+
+      # Creates fragment nodes for methods under the "Class Methods" or "Instance Methods"
+      # fragments.
+      def create_fragment_nodes_for_methods(api_path, klass_node, klass)
+        ["Class", "Instance"].each do |type|
+          method_list = klass.send("#{type.downcase}_method_list")
+          next if method_list.empty?
+          meth_url = "#{klass_node.alcn}##{type}-Methods"
+          path = Webgen::Path.new(meth_url,
+                                  {'handler' => 'copy', 'modified_at' => api_path['modified_at'],
+                                    'pipeline' => [], 'no_output' => true,
+                                    'title' => "#{type} Methods"})
+          meth_node = @website.ext.path_handler.create_secondary_nodes(path).first
+          method_list.sort_by(&:name).each do |method|
+            create_fragment_node_for_method(api_path, meth_node, method)
+          end
+        end
+      end
+      protected :create_fragment_nodes_for_attributes
+
       # Create a fragment node for the given method.
       #
       # A link definition entry for the method is also created.
-      def create_fragment_node_for_method(api_path, klass_node, method)
-        method_url = "#{klass_node.alcn}##{method.aref}"
+      def create_fragment_node_for_method(api_path, parent_node, method)
+        method_url = "#{parent_node.alcn.sub(/#.*$/, '')}##{method.aref}"
         path = Webgen::Path.new(method_url,
                                 {'handler' => 'copy', 'modified_at' => api_path['modified_at'],
+                                  'parent_alcn' => parent_node.alcn,
                                   'pipeline' => [], 'no_output' => true, 'title' => method.name})
         @website.ext.path_handler.create_secondary_nodes(path)
         add_link_definition(api_path, method.full_name, method_url, method.full_name)

data/lib/webgen/version.rb

@@ -3,6 +3,6 @@
 module Webgen
 
   # The version of webgen.
-  VERSION = '1.6.0'
+  VERSION = '1.7.0'
 
 end

data/test/webgen/path_handler/test_api.rb

@@ -5,6 +5,18 @@ require 'webgen/path_handler/api'
 
 class TestPathHandlerApi < Minitest::Test
 
+  # Some Constant
+  TEST_CONST = 42
+
+  # Other Constant
+  OTHER_CONST = 43
+
+  def self.test_meth; end
+  def self.other_meth; end
+
+  attr_reader :test_attr
+  attr_reader :other_attr
+
   class SampleTestSubclass
   end
 
@@ -44,9 +56,31 @@ class TestPathHandlerApi < Minitest::Test
     assert(@website.tree["#{test_alcn}#method-i-setup"])
     assert_equal(["#{test_alcn}#method-i-setup", 'TestPathHandlerApi#setup'],
                  @website.ext.link_definitions['my_api:TestPathHandlerApi#setup'])
+    assert(@website.tree["#{test_alcn}#method-c-test_meth"])
+    assert_equal(["#{test_alcn}#method-c-test_meth", 'TestPathHandlerApi::test_meth'],
+                 @website.ext.link_definitions['my_api:TestPathHandlerApi::test_meth'])
+    assert(@website.tree["#{test_alcn}#attribute-i-test_attr"])
+    assert_equal(["#{test_alcn}#attribute-i-test_attr", 'TestPathHandlerApi#test_attr'],
+                 @website.ext.link_definitions['my_api:TestPathHandlerApi#test_attr'])
+    assert(@website.tree["#{test_alcn}#TEST_CONST"])
+    assert_equal(["#{test_alcn}#TEST_CONST", 'TestPathHandlerApi::TEST_CONST'],
+                 @website.ext.link_definitions['my_api:TestPathHandlerApi::TEST_CONST'])
     assert(@website.tree['/my_dir/API_rdoc.en.html'])
     assert(@website.tree['/my_dir/TestPathHandlerApi/SampleTestSubclass.en.html'])
 
+    collector = lambda do |node|
+      node.children.empty? ? node.lcn : [node.lcn, node.children.map(&collector)]
+    end
+    result = @website.tree[test_alcn].children.map(&collector)
+
+    assert_equal([["#Constants", ["#OTHER_CONST", "#TEST_CONST"]],
+                  ["#Attributes", ["#attribute-i-other_attr", "#attribute-i-test_attr"]],
+                  ["#Class-Methods", ["#method-c-other_meth", "#method-c-test_meth"]],
+                  ["#Instance-Methods", ["#method-i-assert_common_tests_for_create_nodes",
+                  "#method-i-setup", "#method-i-setup_for_create_nodes", "#method-i-teardown",
+                  "#method-i-test_create_nodes", "#method-i-test_create_nodes_hierarchical",
+                  "#method-i-test_rdoc_options", "#method-i-test_rdoc_store"]]], result)
+
     cache_dir = @website.tmpdir(File.join('path_handler.api', 'my_api'))
     assert(File.directory?(cache_dir))
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webgen
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-13 00:00:00.000000000 Z
+date: 2019-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdparse