bitclust-core 1.2.5 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b2eea15e85eb324e528b0528b01f84eae456154be836941cc43375028336fc7
-  data.tar.gz: 2cda706afc4b6bc09d4ca21e51eb9167068554b00193c23ba07f8e8ab9c31b98
+  metadata.gz: 9351ae4c31a9070629d3caca3ea7d7dbc1b323ca1b5840de4aa78d6fd482fe7b
+  data.tar.gz: b80b4414d21ee137c425025778ad750122835b5294ab55012ed7debba0d0ea89
 SHA512:
-  metadata.gz: ed87e3a8a250751dfe518cd40c76b8dc92ee90312810f79e384a78239b7167bbbc80d5da86ca742114f65b977f0338af40a26b8dd62d0890915201c021d1b7ec
-  data.tar.gz: 5377b074eb7f16a473998d9869ae04911f703cdd35fc9306a5153092b185d09f57a8e057dfaded3a08e178f869ae4e3c080ac1bf088756f19636ce5e21f09c62
+  metadata.gz: def1f2a7b7b27922f0dfd2b3559a273e3289b46407be4e478a6af86a05a579ae7d3e6de8321474589fb29aa2a71359bd4dfb76691e73d27f972922b99edd1df3
+  data.tar.gz: 39af952569f246199ec9d258ede5faa937241aeb790368fb8d629aa31531ae0c6277e8c9b80f4e95b608d1131021dfebbd29c321f24519d8d8072d7820a465a2

data/data/bitclust/template.offline/class

@@ -1,6 +1,7 @@
 <%
  @title = "#{@entry.type} #{@entry.name}"
  @description = @entry.description
+ @edit_url = edit_url(@entry.source_location) if @conf[:edit_base_url] && @entry.source_location
 %>
 <% if @conf[:canonical_base_url] %>
 <script type="application/ld+json">
@@ -46,7 +47,7 @@
     </ol>
   </nav>
 <% headline_init %>
-<%= headline("#{@entry.type} #{@entry.name}" + @entry.ancestors[1..@alevel].map{|c| " + #{c.name}" }.join) %>
+<%= headline("#{@entry.type} #{@entry.name}" + @entry.ancestors[1..@alevel].map{|c| " + #{c.name}" }.join, edit_url: @edit_url) %>
 </header>
 
 <main>
@@ -152,9 +153,11 @@ displayed_methods = Set.new(ents.instance_methods.map(&:name))
   <%= headline(_("Ancestor Methods")) %>
 <dl>
   <% ancestors.each do |c|
+       undefined_methods = @entry.partitioned_entries.undefined
        methods = c.partitioned_entries(@alevel).instance_methods
          .flat_map { |m| m.names.map { |n| [n, m] } }
          .reject { |name,| displayed_methods.include?(name) }
+         .reject { |name,| undefined_methods.any? { |m| m.names.include?(name) } }
          .sort
        next if methods.empty? %>
 <dt><%= _('Ancestor Methods %s', c.name) %></dt>

data/data/bitclust/template.offline/doc

@@ -1,6 +1,7 @@
 <%
   @title = @entry.title
   @description = @entry.description
+  @edit_url = edit_url(@entry.source_location) if @conf[:edit_base_url] && @entry.source_location
 %>
 <% if @conf[:canonical_base_url] %>
 <script type="application/ld+json">
@@ -39,7 +40,7 @@
     </ol>
   </nav>
 <% headline_init %>
-<%= headline(@entry.title) %>
+<%= headline(@entry.title, edit_url: @edit_url) %>
 </header>
 
 <main>

data/data/bitclust/template.offline/function

@@ -2,6 +2,7 @@
     entry = @entry
     @title = "#{entry.type_label} #{entry.label}"
     @description = @entry.description
+    @edit_url = edit_url(@entry.source_location) if @conf[:edit_base_url] && @entry.source_location
 %>
 <% if @conf[:canonical_base_url] %>
 <script type="application/ld+json">
@@ -40,7 +41,7 @@
     </ol>
   </nav>
 <% headline_init %>
-<%= headline("#{entry.type_label} #{entry.label}") %>
+<%= headline("#{entry.type_label} #{entry.label}", edit_url: @edit_url) %>
 </header>
 
 <main>

data/data/bitclust/template.offline/layout

@@ -22,7 +22,10 @@
     <img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/3.0/88x31.png" />
   </a>
 
-  フィードバックは<a href="https://github.com/rurema/doctree/issues/new" id="feedback-link">こちら</a>
+  <a href="https://github.com/rurema/doctree/issues/new" id="feedback-link">フィードバックを送る</a>
+  <% if defined?(@edit_url) && @edit_url %>
+    / <a href="<%= @edit_url %>">このマニュアルを編集する</a>
+  <% end %>
   <script>if (window.URLSearchParams) { document.getElementById("feedback-link").search = new URLSearchParams({'body': document.location}); }</script>
 </footer>
 </body>

data/data/bitclust/template.offline/library

@@ -1,6 +1,7 @@
 <%
  @title = "library #{@entry.name}"
  @description = @entry.description
+ @edit_url = edit_url(@entry.source_location) if @conf[:edit_base_url] && @entry.source_location
 %>
 <% if @conf[:canonical_base_url] %>
 <script type="application/ld+json">
@@ -39,7 +40,7 @@
     </ol>
   </nav>
 <% headline_init %>
-<%= headline(@entry.id == '_builtin' ? _('Builtin Library') : "library #{@entry.name}") %>
+<%= headline(@entry.id == '_builtin' ? _('Builtin Library') : "library #{@entry.name}", edit_url: @edit_url) %>
 </header>
 
 <main>

data/data/bitclust/template.offline/method

@@ -2,6 +2,7 @@
     entry = @entries.sort.first
     @title = entry.label
     @description = entry.description
+    @edit_url = edit_url(entry.source_location) if @conf[:edit_base_url] && entry.source_location
 %>
 <% if @conf[:canonical_base_url] %>
 <script type="application/ld+json">

data/lib/bitclust/classentry.rb

@@ -88,6 +88,7 @@ module BitClust
       property :aliases,    '[ClassEntry]'
       property :aliasof,    'ClassEntry'
       property :source,     'String'
+      property :source_location, 'Location'
     }
 
     # FIXME: do not use superclass property aliasing (#6826)
@@ -253,7 +254,7 @@ module BitClust
                        :instance_methods,  :private_instance_methods,
                        :module_functions,
                        :constants, :special_variables,
-                       :added)
+                       :added, :undefined)
 
     def partitioned_entries(level = 0)
       s = []; spv = []
@@ -261,6 +262,7 @@ module BitClust
       mf = []
       c = []; v = []
       added = []
+      undefined = []
       entries(level).sort_by(&:name).each do |m|
         case m.kind
         when :defined, :redefined
@@ -280,9 +282,11 @@ module BitClust
           end
         when :added
           added.push m
+        when :undefined
+          undefined.push m
         end
       end
-      Parts.new(s,spv, i,ipv, mf, c, v, added)
+      Parts.new(s,spv, i,ipv, mf, c, v, added, undefined)
     end
 
     def singleton_methods(level = 0)

data/lib/bitclust/compat.rb

@@ -26,6 +26,14 @@ unless String.method_defined?(:bytesize)
   end
 end
 
+unless String.method_defined?(:match?)
+  class String
+    def match?(pattern, pos = 0)
+      !match(pattern, pos).nil?
+    end
+  end
+end
+
 def fopen(*args, &block)
   option = args[1]
   if option and !Object.const_defined?(:Encoding)

data/lib/bitclust/docentry.rb

@@ -57,8 +57,9 @@ module BitClust
     end
 
     persistent_properties {
-      property :title,    'String'
-      property :source,   'String'
+      property :title,           'String'
+      property :source,          'String'
+      property :source_location, 'Location'
     }
 
     def inspect

data/lib/bitclust/entry.rb

@@ -98,6 +98,7 @@ module BitClust
         when '[LibraryEntry]' then "[]"
         when '[ClassEntry]'   then "[]"
         when '[MethodEntry]'  then "[]"
+        when 'Location'       then "nil"
         else
           raise "must not happen: @type=#{@type.inspect}"
         end
@@ -115,6 +116,7 @@ module BitClust
         when '[LibraryEntry]' then "restore_libraries(h['#{@name}'])"
         when '[ClassEntry]'   then "restore_classes(h['#{@name}'])"
         when '[MethodEntry]'  then "restore_methods(h['#{@name}'])"
+        when 'Location'       then "h['#{@name}']&.tap { |loc| break if loc.empty?; break Location.new(*loc.split(?:)) }"
         else
           raise "must not happen: @type=#{@type.inspect}"
         end
@@ -132,6 +134,7 @@ module BitClust
         when '[LibraryEntry]' then "serialize_entries(@#{@name})"
         when '[ClassEntry]'   then "serialize_entries(@#{@name})"
         when '[MethodEntry]'  then "serialize_entries(@#{@name})"
+        when 'Location'       then "@#@name.to_s"
         else
           raise "must not happen: @type=#{@type.inspect}"
         end

data/lib/bitclust/functionentry.rb

@@ -37,13 +37,14 @@ module BitClust
     end
 
     persistent_properties {
-      property :filename,   'String'
-      property :macro,      'bool'
-      property :private,    'bool'
-      property :type,       'String'
-      property :name,       'String'
-      property :params,     'String'
-      property :source,     'String'
+      property :filename,        'String'
+      property :macro,           'bool'
+      property :private,         'bool'
+      property :type,            'String'
+      property :name,            'String'
+      property :params,          'String'
+      property :source,          'String'
+      property :source_location, 'Location'
     }
 
     attr_reader :id

data/lib/bitclust/functionreferenceparser.rb

@@ -34,6 +34,7 @@ module BitClust
 
     def parse(f, filename, params = {})
       @filename = filename
+      @path = f.path
       s = Preprocessor.read(f, params)
       file_entries LineInput.for_string(s)
       @db.functions
@@ -59,6 +60,7 @@ module BitClust
         f.name = h.name
         f.params = h.params
         f.source = body.join('')
+        f.source_location = body[0]&.location&.tap {|loc| break Location.new(@path, loc.line - 1) }
       }
     end
 

data/lib/bitclust/libraryentry.rb

@@ -73,6 +73,7 @@ module BitClust
       property :sublibraries, '[LibraryEntry]'
       property :is_sublibrary,   'bool'
       property :category, 'String'
+      property :source_location, 'Location'
     }
 
     def inspect

data/lib/bitclust/lineinput.rb

@@ -9,6 +9,7 @@
 #
 
 require 'stringio'
+require 'bitclust/parseutils'
 
 # Utility class for line-wise file parsing
 class LineInput
@@ -34,7 +35,7 @@ class LineInput
   end
 
   def path
-    @input.path
+    @input.path if @input.respond_to?(:path)
   end
 
   def name
@@ -52,12 +53,15 @@ class LineInput
   def gets
     unless @buf.empty?
       @lineno += 1
-      return @buf.pop
+      line = @buf.pop
+      line&.location ||= BitClust::Location.new(path, @lineno)
+      return line
     end
     return nil if @eof_p   # to avoid ARGF blocking.
     line = @input.gets
     @eof_p = true unless line
     @lineno += 1
+    line&.location ||= BitClust::Location.new(path, @lineno)
     line
   end
 

data/lib/bitclust/methoddatabase.rb

@@ -175,14 +175,17 @@ module BitClust
     end
 
     def copy_doc
+      root_path = Pathname.new(@root).expand_path
       Dir.glob("#{@root}/../../doc/**/*.rd").each do |f|
         if %r!\A#{Regexp.escape(@root)}/\.\./\.\./doc/([-\./\w]+)\.rd\z! =~ f
           id = libname2id($1)
           se = DocEntry.new(self, id)
           s = Preprocessor.read(f, properties)
           title, source = RRDParser.split_doc(s)
+          relative_path = Pathname.new(f).expand_path(@root).relative_path_from(root_path)
           se.title = title
           se.source = source
+          se.source_location = Location.new(relative_path, 1)
           se.save
         end
       end

data/lib/bitclust/methodentry.rb

@@ -95,10 +95,11 @@ module BitClust
     attr_writer :klass
 
     persistent_properties {
-      property :names,      '[String]'
-      property :visibility, 'Symbol'   # :public | :private | :protected
-      property :kind,       'Symbol'   # :defined | :added | :redefined
-      property :source,     'String'
+      property :names,           '[String]'
+      property :visibility,      'Symbol'   # :public | :private | :protected
+      property :kind,            'Symbol'   # :defined | :added | :redefined
+      property :source,          'String'
+      property :source_location, 'Location'
     }
 
     def inspect

data/lib/bitclust/preprocessor.rb

@@ -71,6 +71,10 @@ module BitClust
       cond_init
     end
 
+    def path
+      @f.path if @f.respond_to?(:path)
+    end
+
     private
 
     def next_line(f)

data/lib/bitclust/rdcompiler.rb

@@ -393,6 +393,10 @@ module BitClust
         string a_href(@urlmapper.method_url(methodid2specstring(@method.id)), "permalink")
         string ']['
         string rdoc_link(@method.id, @option[:database].properties["version"])
+        if @option[:edit_base_url] && @method.source_location
+          string ']['
+          string a_href(@urlmapper.edit_url(@method.source_location), 'edit')
+        end
         string ']</span>'
       end
       if @method and not @method.defined?

data/lib/bitclust/rrdparser.rb

@@ -10,6 +10,7 @@
 require 'bitclust/compat'
 require 'bitclust/preprocessor'
 require 'bitclust/methodid'
+require 'bitclust/methoddatabase'
 require 'bitclust/lineinput'
 require 'bitclust/parseutils'
 require 'bitclust/nameutils'
@@ -69,7 +70,7 @@ module BitClust
 
     def parse_file(path, libname, params = {})
       fopen(path, 'r:UTF-8') {|f|
-        return parse(f, libname, params)
+        return parse(f, libname, params).tap { |lib| lib.source_location = Location.new(path, 1) }
       }
     end
 
@@ -113,14 +114,14 @@ module BitClust
         type, name, superclass = *parse_level1_header(line)
         case type
         when 'class'
-          @context.define_class name, (superclass || 'Object')
+          @context.define_class name, (superclass || 'Object'), location: line.location
           read_class_body f
         when 'module'
           parse_error "superclass given for module", line  if superclass
-          @context.define_module name
+          @context.define_module name, location: line.location
           read_class_body f
         when 'object'
-          @context.define_object name, superclass
+          @context.define_object name, superclass, location: line.location
           read_object_body f
         when 'reopen'
           @context.reopen_class name
@@ -348,30 +349,31 @@ module BitClust
         @library.sublibrary @db.get_library(libname)
       end
 
-      def define_class(name, supername)
+      def define_class(name, supername, location: nil)
         if @db.properties['version'] >= "1.9.0"
           top = 'BasicObject'
         else
           top = 'Object'
         end
         superclass = (name == top ? nil : @db.get_class(supername))
-        register_class :class, name, superclass
+        register_class :class, name, superclass, location: location
       end
 
-      def define_module(name)
-        register_class :module, name, nil
+      def define_module(name, location: nil)
+        register_class :module, name, nil, location: location
       end
 
-      def define_object(name, singleton_object_class)
+      def define_object(name, singleton_object_class, location: nil)
         singleton_object_class = @db.get_class(singleton_object_class) if singleton_object_class
-        register_class :object, name, singleton_object_class
+        register_class :object, name, singleton_object_class, location: location
       end
 
-      def register_class(type, name, superclass)
+      def register_class(type, name, superclass, location: nil)
         @klass = @db.open_class(name) {|c|
           c.type = type
           c.superclass = superclass
           c.library = @library
+          c.source_location = location
           @library.add_class c
         }
         @kind = :defined
@@ -448,10 +450,11 @@ module BitClust
       def define_method(chunk)
         id = method_id(chunk)
         @db.open_method(id) {|m|
-          m.names      = chunk.names.sort
-          m.kind       = @kind
-          m.visibility = @visibility || :public
-          m.source     = chunk.source
+          m.names           = chunk.names.sort
+          m.kind            = chunk.source.match?(/^@undef$/) ? :undefined : @kind
+          m.visibility      = @visibility || :public
+          m.source          = chunk.source
+          m.source_location = chunk.source.location
           case @kind
           when :added, :redefined
             @library.add_method m

data/lib/bitclust/screen.rb

@@ -368,6 +368,10 @@ module BitClust
       @urlmapper.canonical_url(current_url)
     end
 
+    def edit_url(location)
+      @urlmapper.edit_url(location)
+    end
+
     def opensearchdescription_url
       @urlmapper.opensearchdescription_url
     end
@@ -396,8 +400,11 @@ module BitClust
       @hlevel -= 1
     end
 
-    def headline(str)
-      "<h#{@hlevel}>#{escape_html(str)}</h#{@hlevel}>"
+    def headline(str, edit_url: nil)
+      edit_link = edit_url ? <<~HTML : ''
+        <span class="permalink">[<a href="#{edit_url}">edit</a>]</span>
+      HTML
+      "<h#{@hlevel}>#{escape_html(str)}</h#{@hlevel}>" + edit_link
     end
 
     def headline_noescape(str)

data/lib/bitclust/subcommands/statichtml_command.rb

@@ -28,6 +28,7 @@ module BitClust
           @suffix = h[:suffix]
           @fs_casesensitive = h[:fs_casesensitive]
           @canonical_base_url = h[:canonical_base_url]
+          @edit_base_url = h[:edit_base_url]
         end
 
         def library_url(name)
@@ -87,6 +88,10 @@ module BitClust
           (@canonical_base_url + "/#{current_url}").sub(@bitclust_html_base, "").sub(/([^:])\/\/+/, "\\1/")
         end
 
+        def edit_url(location)
+          "#{@edit_base_url}/#{location.file}#L#{location.line}".sub(/([^:])\/\/+/, "\\1/")
+        end
+
         def encodename_package(str)
           if @fs_casesensitive
             encodename_url(str)
@@ -141,6 +146,9 @@ module BitClust
         @parser.on('--canonical-base-url=URL', 'Canonical base URL') do |url|
           @canonical_base_url = url
         end
+        @parser.on('--edit-base-url=URL', 'Edit base URL') do |url|
+          @edit_base_url = url
+        end
         @parser.on('--tracking-id=ID', 'Google Tag Manager Tracking ID') do |id|
           @gtm_tracking_id = id
         end
@@ -225,6 +233,7 @@ module BitClust
           :tochm_mode  => true,
           :fs_casesensitive => @fs_casesensitive,
           :canonical_base_url => @canonical_base_url,
+          :edit_base_url => @edit_base_url,
           :gtm_tracking_id => @gtm_tracking_id,
           :meta_robots_content => @meta_robots_content,
           :stop_on_syntax_error => @stop_on_syntax_error,

data/lib/bitclust/version.rb

@@ -1,3 +1,3 @@
 module BitClust
-  VERSION = "1.2.5"
+  VERSION = "1.2.6"
 end

data/test/test_entry.rb

@@ -9,6 +9,14 @@ alias HogeHoge
 alias HogeHogeHoge
 == Class Methods
 --- hoge
+hoge
+--- fuga
+@undef
+fuga
+== Instance Methods
+--- fugafuga
+@undef
+fugafuga
 = class Bar < Hoge
 == Class Methods
 --- bar
@@ -19,7 +27,7 @@ HERE
   end
 
   def test_entries
-    assert_equal(['bar', 'hoge'],
+    assert_equal(['bar', 'fuga', 'fugafuga', 'hoge'],
                  @lib.fetch_class("Bar").entries(1).map{|e| e.name}.sort)
   end
 
@@ -45,6 +53,11 @@ HERE
     assert(@lib.fetch_class("ErrErr").error_class?)
   end
 
+  def test_partitioned_entries
+    parts = @lib.fetch_class('Hoge').partitioned_entries
+    assert_equal(['fuga', 'fugafuga'], parts.undefined.map(&:name))
+  end
+
   def test_superclass
     assert('Exception', @lib.fetch_class("Err").superclass.name)
     assert('Exception', @lib.fetch_class("ErrErr").superclass.name)

data/test/test_rrdparser.rb

@@ -23,4 +23,20 @@ a
 HERE
     assert_equal(["", "==[a:hoge]hoge\na\n"], result)
   end
+
+  def test_undef
+    result = BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_undef
+
+@undef
+
+このメソッドは利用できない
+
+HERE
+    _library, methoddatabase = result
+    test_undef_spec = BitClust::MethodSpec.parse('Dummy#test_undef')
+    assert_equal(:undefined, methoddatabase.get_method(test_undef_spec).kind)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitclust-core
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.2.6
 platform: ruby
 authors:
 - https://github.com/rurema
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -237,6 +237,7 @@ metadata:
   documentation_uri: https://github.com/rurema/doctree/wiki
   homepage_uri: https://docs.ruby-lang.org/ja/
   source_code_uri: https://github.com/rurema/bitclust
+  github_repo: https://github.com/rurema/bitclust
   wiki_uri: https://github.com/rurema/doctree/wiki
 post_install_message: 
 rdoc_options: []
@@ -258,19 +259,19 @@ signing_key:
 specification_version: 4
 summary: BitClust is a rurema document processor.
 test_files:
-- test/test_functionreferenceparser.rb
-- test/test_refsdatabase.rb
-- test/test_rrdparser.rb
 - test/test_syntax_highlighter.rb
-- test/test_methoddatabase.rb
-- test/test_simplesearcher.rb
-- test/test_nameutils.rb
-- test/run_test.rb
 - test/test_methodsignature.rb
-- test/test_rdcompiler.rb
 - test/test_functiondatabase.rb
-- test/test_runner.rb
-- test/test_bitclust.rb
-- test/test_entry.rb
 - test/test_preprocessor.rb
+- test/test_refsdatabase.rb
+- test/test_nameutils.rb
+- test/test_bitclust.rb
+- test/test_simplesearcher.rb
+- test/test_rdcompiler.rb
 - test/test_libraryentry.rb
+- test/test_runner.rb
+- test/test_rrdparser.rb
+- test/test_methoddatabase.rb
+- test/test_functionreferenceparser.rb
+- test/run_test.rb
+- test/test_entry.rb