headown 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 605fa3f8a4bbc3fc2a4f4bf2111ce8300d2d0bcc42d3e6b8fd14c445c97e3746
-  data.tar.gz: 03c2bee496d9b0faf82df64d23214b0487120915c128be88a2297759b710afdb
+  metadata.gz: 541a08c3b53c77ecdf85ffd2304f159c3d77c8fe035015476132faa3d1eea08a
+  data.tar.gz: bd9a343fec1e22785efc3c0dddd6b3799b0bd6cc6c3ee065ed93cb084dfdcbab
 SHA512:
-  metadata.gz: 78d66b6d263ecf33aa389cc72a1419d8390aafafaa7c4ce2e052e2acf0293d2d943a6bd7851ed5a818a7b2858b8677ed82ac0cd59db26f5c0b0bca8d4609bc24
-  data.tar.gz: 951d0697a49ded9d3d9d33bab2c86d525c4135fdb5425db76b410a100751fb20f92a250cfa0782636f1b1931c5a701a7bd579ceeb2886c636cc9691cd0bdb20c
+  metadata.gz: 47ef832759faba71f2c39a7909f98d428b544da18b1ddf30ddc729e9d4d7a722c4a144bceb65720e4523111b22b48229989339e3084dab9a8ef7603ecb8076ef
+  data.tar.gz: 0d21103d9d5e864bd957b45c7c974523f33a78b93c7adad8d5d5b058bbcfa213c6a261494bdf644c2cc41e725edefe5d901a06830d6ccc35ad4adb680f095031

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Setup Ruby
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: ['2.7', '3.0', '3.1']
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake
+    - name: Type checking
+      run: bundle exec steep check

data/CHANGELOG.md

@@ -0,0 +1 @@
+https://github.com/noriyotcp/headown/releases

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in headown.gemspec
 gemspec
 
-gem 'rake', '~> 12.0'
+gem 'rake'
 gem 'rspec', '~> 3.0'
 gem 'commonmarker'
 gem 'thor'
@@ -11,3 +11,7 @@ gem 'thor'
 group :development do
   gem 'prettier'
 end
+
+group :development, :test do
+  gem 'steep'
+end

data/Gemfile.lock

@@ -1,35 +1,88 @@
 PATH
   remote: .
   specs:
-    headown (0.1.0)
+    headown (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    commonmarker (0.21.0)
-      ruby-enum (~> 0.5)
-    concurrent-ruby (1.1.7)
-    diff-lcs (1.4.4)
-    i18n (1.8.5)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    commonmarker (0.23.6)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    ffi (1.15.5)
+    haml (6.0.7)
+      temple (>= 0.8.2)
+      thor
+      tilt
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    prettier (0.20.1)
-    rake (12.3.3)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    language_server-protocol (3.17.0.1)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    prettier (3.2.2)
+      syntax_tree (>= 2.7.1)
+      syntax_tree-haml (>= 1.1.0)
+      syntax_tree-rbs (>= 0.2.0)
+    prettier_print (0.1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (2.7.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    ruby-enum (0.8.0)
-      i18n
-    thor (1.0.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    securerandom (0.2.0)
+    steep (1.2.0)
+      activesupport (>= 5.1)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      parallel (>= 1.0.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 2.7.0)
+      securerandom (>= 0.1)
+      terminal-table (>= 2, < 4)
+    syntax_tree (3.6.3)
+      prettier_print
+    syntax_tree-haml (1.3.2)
+      haml (>= 5.2)
+      prettier_print
+      syntax_tree (>= 2.0.1)
+    syntax_tree-rbs (0.5.1)
+      prettier_print
+      rbs
+      syntax_tree (>= 2.0.1)
+    temple (0.8.2)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.1)
+    tilt (2.0.11)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
   ruby
@@ -38,9 +91,10 @@ DEPENDENCIES
   commonmarker
   headown!
   prettier
-  rake (~> 12.0)
+  rake
   rspec (~> 3.0)
+  steep
   thor
 
 BUNDLED WITH
-   2.1.2
+   2.3.10

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-From this following file
+From this following file:
 
 ```markdown
 # h1
@@ -45,11 +45,11 @@ This is h5.
 
 ###### h6
 
-This is h5.
+This is h6.
 
 ```
 
-Extracts headers only
+Extracts headers only:
 
 ```shell script
 $ headown extract ./spec/headown/sample.md
@@ -61,7 +61,7 @@ $ headown extract ./spec/headown/sample.md
 ###### h6
 ```
 
-From online
+From online:
 
 ```shell script
 $ headown extract https://raw.githubusercontent.com/noriyotcp/headown/main/spec/headown/sample.md
@@ -73,7 +73,7 @@ $ headown extract https://raw.githubusercontent.com/noriyotcp/headown/main/spec/
 ###### h6
 ```
 
-ATX headings can interrupt paragraphs
+ATX headings can interrupt paragraphs:
 
 ```markdown
 ****
@@ -85,12 +85,23 @@ ATX headings can interrupt paragraphs
 <hr />
 ```
 
-So, it extracts headers
+So, it extracts headers:
 
 ```shell script
 $ headown extract ./spec/headown/sample2.md
 # baz
 ```
+
+You can also use it in a Ruby file:
+
+```ruby
+require 'headown'
+#=> true
+extractor = Headown::Extractor.new('spec/headown/sample.md')
+extractor.headers
+#=> ["# h1", "## h2", "### h3", "#### h4", "##### h5", "###### h6"]
+```
+
 ## 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.

data/Steepfile

@@ -0,0 +1,23 @@
+# D = Steep::Diagnostic
+#
+target :lib do
+  signature "sig"
+  check "lib"                       # Directory name
+#   # check "Gemfile"                   # File name
+#   # library "pathname", "set"       # Standard libraries
+#   # library "strong_json"           # Gems
+#
+#   # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+#   # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+#   # configure_code_diagnostics do |hash|             # You can setup everything yourself
+#   #   hash[D::Ruby::NoMethod] = :information
+#   # end
+end
+
+# target :test do
+#   signature "sig", "sig-private"
+#
+#   check "test"
+#
+#   # library "pathname", "set"       # Standard libraries
+# end

data/exe/headown

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
-require "headown"
+require 'headown'
+require 'headown/cli'
 
 Headown::CLI.start(ARGV)

data/headown.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description = 'This is the CLI tool extracting headers from Markdown files.'
   spec.homepage = 'https://github.com/noriyotcp/headown'
   spec.license = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 

data/lib/headown/cli.rb

@@ -1,35 +1,17 @@
 require 'thor'
-require 'commonmarker'
-require 'open-uri'
 
 module Headown
   class CLI < Thor
     desc 'extract <path>', 'extract headers from file path'
 
     def extract(file_path)
-      file_data = URI.open(file_path, &:read)
-      puts_headers(file_data)
-    end
-
-    private
-
-    def header_nodes(data)
-      doc = CommonMarker.render_doc(data)
-      [].tap { |nodes| doc.walk { |node| nodes << node if node.type == :header } }
-    end
-
-    def build_header(node)
-      text = ''
-      node.each { |subnode| text = subnode.string_content if subnode.type == :text }
-      '#' * node.header_level + " #{text}"
-    end
-
-    def extract_headers(file_data)
-      header_nodes(file_data).map { |node| build_header(node) }
-    end
-
-    def puts_headers(file_data)
-      puts extract_headers(file_data)
+      extractor = Headown::Extractor.new(file_path)
+      puts extractor.headers
+    rescue Headown::NotMarkdownError => e
+      puts <<~MSG
+      #{e.class}:
+        #{e.message}
+      MSG
     end
   end
 end

data/lib/headown/version.rb

@@ -1,3 +1,3 @@
 module Headown
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

data/lib/headown.rb

@@ -1,6 +1,40 @@
 require 'headown/version'
-require 'headown/cli'
+require 'open-uri'
+require 'commonmarker'
 
 module Headown
-  class Error < StandardError; end # Your code goes here...
+  class NotMarkdownError < StandardError
+    def initialize(file_path:)
+      msg = "#{file_path} is not a Markdown file."
+      super(msg)
+    end
+  end
+
+  class Extractor
+    attr_reader :headers
+
+    def initialize(file_path)
+      raise Headown::NotMarkdownError.new(file_path: file_path) if File.extname(file_path) != '.md'
+
+      file_data = URI.open(file_path, &:read)
+      extract_headers(file_data)
+    end
+
+    private
+
+    def extract_headers(file_data)
+      @headers = header_nodes(file_data).map { |node| build_header(node) }
+    end
+
+    def header_nodes(data)
+      doc = CommonMarker.render_doc(data)
+      [].tap { |nodes| doc.walk { |node| nodes << node if node.type == :header } }
+    end
+
+    def build_header(node)
+      text = ''
+      node.each { |subnode| text = subnode.string_content if subnode.type == :text }
+      '#' * node.header_level + " #{text}"
+    end
+  end
 end

data/sig/headown.rbs

@@ -0,0 +1,47 @@
+# TypeProf 0.21.2
+
+# polyfill for thor
+class Thor
+  def self.desc: (String, String, ?Hash[Symbol, String]) -> void
+end
+
+# polyfill for URI
+class URI
+  def self.open: (String) { (IO) -> (::String | nil) } -> IO
+end
+
+# polyfill for commonmarker
+module CommonMarker
+  def self.render_doc: (::IO | nil) -> CommonMarker::Node
+
+  class Node
+    def each: [U] { (Node) -> U } -> ::Array[U]
+    def walk: [U] { (Node) -> U } -> ::Array[U]
+    attr_reader type: Symbol
+    attr_reader string_content: String
+    attr_reader header_level: Integer
+  end
+end
+
+# Classes
+module Headown
+  VERSION: String
+
+  class NotMarkdownError < StandardError
+    def initialize: (file_path: String) -> void
+  end
+
+  class Extractor
+    attr_reader headers: Array[String]
+    def initialize: (String file_path) -> Array[String]
+
+    private
+    def extract_headers: (IO file_data) -> Array[String]
+    def header_nodes: (IO data) -> Array[CommonMarker::Node]
+    def build_header: (CommonMarker::Node node) -> String
+  end
+
+  class CLI < Thor
+    def extract: (String file_path) -> void
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: headown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - noriyotcp
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-27 00:00:00.000000000 Z
+date: 2022-10-16 00:00:00.000000000 Z
 dependencies: []
 description: This is the CLI tool extracting headers from Markdown files.
 email:
@@ -18,16 +18,18 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".prettierrc.json"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - bin/console
 - bin/setup
 - exe/headown
@@ -35,6 +37,7 @@ files:
 - lib/headown.rb
 - lib/headown/cli.rb
 - lib/headown/version.rb
+- sig/headown.rbs
 homepage: https://github.com/noriyotcp/headown
 licenses:
 - MIT
@@ -51,14 +54,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Markdown Headers Extractor

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.0
-before_install: gem install bundler -v 2.1.2