headown 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 605fa3f8a4bbc3fc2a4f4bf2111ce8300d2d0bcc42d3e6b8fd14c445c97e3746
-  data.tar.gz: 03c2bee496d9b0faf82df64d23214b0487120915c128be88a2297759b710afdb
+  metadata.gz: f74423e86a239a4baf00b000cf0ff3fd13ab4af7082750388faa8c462a7ccf20
+  data.tar.gz: ed615e669ad789158a317dba43c7234793f23e2e76ec693ce626466aaab63c31
 SHA512:
-  metadata.gz: 78d66b6d263ecf33aa389cc72a1419d8390aafafaa7c4ce2e052e2acf0293d2d943a6bd7851ed5a818a7b2858b8677ed82ac0cd59db26f5c0b0bca8d4609bc24
-  data.tar.gz: 951d0697a49ded9d3d9d33bab2c86d525c4135fdb5425db76b410a100751fb20f92a250cfa0782636f1b1931c5a701a7bd579ceeb2886c636cc9691cd0bdb20c
+  metadata.gz: 788b6416a14427891723fad67e53645514e6eeb647443f81f0f3ac18bcff177d0dc3d83de7cb469c49022626db239632d27cb615b6d458a82d3c16d1f7ce9f08
+  data.tar.gz: f6c74ca98eeb4efc4236784a56368d15f6f1ab06908c88f74f6fed9e0e7cf2249e0f1502c7b803fbd47c1b5c4f10c57a9ddc0893e1ea4933a3e28b7be162a67e

data/.chglog/CHANGELOG.tpl.md

@@ -0,0 +1,38 @@
+{{ range .Versions }}
+<a name="{{ .Tag.Name }}"></a>
+## {{ if .Tag.Previous }}[{{ .Tag.Name }}]({{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}){{ else }}{{ .Tag.Name }}{{ end }} ({{ datetime "2006-01-02" .Tag.Date }})
+
+{{ range .CommitGroups -}}
+### {{ .Title }}
+
+{{ range .Commits -}}
+* {{ .Subject }}
+{{ end }}
+{{ end -}}
+
+{{- if .RevertCommits -}}
+### Reverts
+
+{{ range .RevertCommits -}}
+* {{ .Revert.Header }}
+{{ end }}
+{{ end -}}
+
+{{- if .MergeCommits -}}
+### Pull Requests
+
+{{ range .MergeCommits -}}
+* {{ .Header }}
+{{ end }}
+{{ end -}}
+
+{{- if .NoteGroups -}}
+{{ range .NoteGroups -}}
+### {{ .Title }}
+
+{{ range .Notes }}
+{{ .Body }}
+{{ end }}
+{{ end -}}
+{{ end -}}
+{{ end -}}

data/.chglog/config.yml

@@ -0,0 +1,27 @@
+style: github
+template: CHANGELOG.tpl.md
+info:
+  title: CHANGELOG
+  repository_url: https://github.com/noriyotcp/headown
+options:
+  commits:
+    # filters:
+    #   Type:
+    #     - feat
+    #     - fix
+    #     - perf
+    #     - refactor
+  commit_groups:
+    # title_maps:
+    #   feat: Features
+    #   fix: Bug Fixes
+    #   perf: Performance Improvements
+    #   refactor: Code Refactoring
+  header:
+    pattern: "^((\\w+)\\s.*)$"
+    pattern_maps:
+      - Subject
+      - Type
+  notes:
+    keywords:
+      - BREAKING CHANGE

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: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.7
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+<a name="v0.2.0"></a>
+## [v0.2.0](https://github.com/noriyotcp/headown/compare/v0.1.0...v0.2.0) (2020-10-03)
+
+### Add
+
+* Add Headown::Extractor which has logic to extract headers
+* Add CHANGELOG.md
+* Add .chglog which contains git-chglog's config and template files
+
+### Create
+
+* Create ruby.yml
+
+### Improve
+
+* Improve test against html file path
+* Raise Headown::NotMarkdownError in constructor in Headown::Extractor
+* Raise Headown::NotMarkdownError when file path is not Markdown file
+
+### Update
+
+* Move require 'headown/cli' to exe/headown
+* Update README.md
+* Update CHANGELOG.md
+
+### Pull Requests
+
+* Merge pull request [#4](https://github.com/noriyotcp/headown/issues/4) from noriyotcp/noriyotcp-patch-1
+* Merge pull request [#3](https://github.com/noriyotcp/headown/issues/3) from noriyotcp/extractor-class
+* Merge pull request [#2](https://github.com/noriyotcp/headown/issues/2) from noriyotcp/extract-require-headown-cli
+* Merge pull request [#1](https://github.com/noriyotcp/headown/issues/1) from noriyotcp/detect-file-extension
+
+<a name="v0.1.0"></a>
+## v0.1.0 (2020-09-27)
+
+### Add
+
+* Add sample2.md to test against interruption paragraphs for ATX headings
+* Add test against passing url
+* Add puts_headers to print headers out to stdout
+
+### Exec
+
+* Exec bundle exec rbprettier --write '**/*.rb'
+
+### Improve
+
+* Extract from sample markdown file
+* Improve sample.md
+
+### Install
+
+* Install prettier gem
+* Install thor
+* Install gems
+
+### Update
+
+* Update README.md
+* Update gemspec
+* Update headown.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    headown (0.1.0)
+    headown (0.2.0)
 
 GEM
   remote: https://rubygems.org/

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/exe/headown

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

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/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.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: headown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - noriyotcp
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-27 00:00:00.000000000 Z
+date: 2020-10-03 00:00:00.000000000 Z
 dependencies: []
 description: This is the CLI tool extracting headers from Markdown files.
 email:
@@ -18,10 +18,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".chglog/CHANGELOG.tpl.md"
+- ".chglog/config.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".prettierrc.json"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock