synclenote 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 909401f6f0f32860825c396ef438f53fd53447260570a88c234ae330b38dbb26
-  data.tar.gz: b49889059a4adbc1a370acbcb7b3943aeb6099ea724b4008146cad193bd1b344
+  metadata.gz: 6842ad72e5f7f899d1b5d962b8af0db7cae65c99e16693cedd43de396b51c529
+  data.tar.gz: 296010bb3a8b526e43a49986314076bb85be2cd9a7c2cade2fd4a50eb6cf361f
 SHA512:
-  metadata.gz: 802161aaf2e5bee2769aa5da00352ee0029a829b428afa72f67aa71259458bc7594e21512ac838973aa103fe0c46c076ddf772f7eba78f6b6692b4bb9c5527c6
-  data.tar.gz: 6c8b25dfbbbbf568ffbee06de751f4267620fb4ed309d8d391823dbf6f0cda951f3682eb59a927e58fedfa999cf7e988a2d073acf46f559d3dc2f6ea7e3b9672
+  metadata.gz: b64e8832799ca114404b838d28fb159d4730072041caf405601d372ada55a25816741486cdcc864e89b4ea8c500a7b4de640d7f5bf26d1c01c4abc5a3beddc92
+  data.tar.gz: 7f1a3179d818e0fcff4e3174ce66d517d05e87ed8f31447cbaaa6c80e6ef2888501286c315107ca7050e380fb8be94d1ccd8252a749c0897fda393a89d472821

data/.github/workflows/test.yml

@@ -0,0 +1,68 @@
+name: test
+
+on:
+  - pull_request
+  - push
+  - workflow_dispatch
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - macos
+          - ubuntu
+          - windows
+        ruby_version:
+          - 3.3
+          - 3.2
+          - 3.1
+    runs-on: ${{ matrix.os }}-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: kenchan0130/actions-system-info@1.2.0
+        id: system-info
+      - name: Cache rubygems
+        uses: actions/cache@v3.2.2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ steps.system-info.outputs.release }}-rubygems-${{ matrix.ruby_version }}-${{ hashFiles('**/Gemfile') }}-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ steps.system-info.outputs.release }}-rubygems-${{ matrix.ruby_version }}
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - name: Install dependencies
+        shell: bash
+        run: |
+          set -eux
+          gem update --system
+          bundle config path vendor/bundle
+          bundle install --jobs "${{ steps.system-info.outputs.cpu-core }}" --retry 3
+      - name: Run tests
+        run: bundle exec rake
+      - name: Output versions
+        if: always()
+        shell: bash
+        run: |
+          set -eux
+          run_if_exist() {
+            if test "x$(which $1)" != "x"
+            then
+              "$@"
+            fi
+          }
+          uname -a
+          run_if_exist sw_vers # macos
+          run_if_exist lsb_release --all # ubuntu
+          ruby --version
+          gem --version
+          bundle --version
+      - name: Output gem versions
+        if: always()
+        run: bundle list
+      - name: Output deb package versions
+        if: always() && matrix.os == 'ubuntu'
+        run: dpkg -l

data/.gitignore

@@ -19,3 +19,4 @@ tmp
 *.o
 *.a
 mkmf.log
+/Gemfile.lock

data/Rakefile

@@ -1,3 +1,9 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
 
-task default: %i(build)
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task(default: %i[test build])

data/lib/synclenote/command.rb

@@ -1,5 +1,3 @@
-require "synclenote"
-
 require "yaml"
 require "pathname"
 require "logger"
@@ -135,16 +133,6 @@ EOS
 # -*- mode: yaml -*-
 # vi: set ft=yaml :
 
-EOS
-
-  HEADER = <<EOS.freeze
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE en-note SYSTEM "http://xml.evernote.com/pub/enml2.dtd">
-<en-note>
-EOS
-
-  FOOTER = <<EOS.freeze
-</en-note>
 EOS
 
   def load_yaml_path(path)
@@ -181,45 +169,8 @@ EOS
     return 4 # 4 sec for sandbox
   end
 
-  def build_html(markdown_text)
-    @formatter ||= Redcarpet::Markdown.new(
-      Redcarpet::Render::HTML.new(
-        filter_html: true,
-        hard_wrap: true,
-      ),
-      underline: true,
-      lax_spacing: true,
-      footnotes: true,
-      no_intra_emphasis: true,
-      superscript: true,
-      strikethrough: true,
-      tables: true,
-      space_after_headers: true,
-      fenced_code_blocks: true,
-      # autolink: true,
-    )
-    html = @formatter.render(markdown_text)
-    return html
-  end
-
-  def create_note(note_path, options = {})
-    title = nil
-    tags = ["syncle"]
-    body = nil
-    note_path.open do |f|
-      title = f.gets.chomp.sub(/\A#\s*/, "")
-      if md = /\A(?<tags>(?:\[.*?\])+)(?:\s|\z)/.match(title)
-        tags += md[:tags].scan(/\[(.*?)\]/).flatten
-        title = md.post_match
-      end
-      body = f.read
-    end
-    html = build_html(body)
-    content = HEADER +
-      html.gsub(/ class=\".*?\"/, "").gsub(/<(br|hr|img).*?>/, "\\&</\\1>") +
-      FOOTER
-    o = options.merge(title: title, content: content, tagNames: tags)
-    return Evernote::EDAM::Type::Note.new(o)
+  def create_note(note_path, **options)
+    return Synclenote::NoteBuilder.(note_path, **options)
   end
 
   def target_note?(note)
@@ -245,7 +196,7 @@ EOS
                     }.to_yaml)
       tmp_file.close
       path.parent.mkpath
-      FileUtils.mv(tmp_file.path, path)
+      FileUtils.mv(tmp_file.path, path) if !Synclenote::DRY_RUN
     end
   end
 
@@ -257,7 +208,12 @@ EOS
       return
     end
     logger.debug("doing createNote: %s" % note_path)
-    created_note = note_store.createNote(token, new_note)
+    created_note =
+      if Synclenote::DRY_RUN
+        Evernote::EDAM::Type::Note.new(guid: "created_note_dummy_guid")
+      else
+        note_store.createNote(token, new_note)
+      end
     logger.debug("done createNote.")
     create_note_sync_status_file(note_sync_status_path, created_note,
                                  Time.now)
@@ -273,7 +229,12 @@ EOS
       return
     end
     logger.debug("doing updateNote: %s %s" % [note_path, guid])
-    updated_note = note_store.updateNote(token, new_note)
+    updated_note =
+      if Synclenote::DRY_RUN
+        Evernote::EDAM::Type::Note.new(guid: "updated_note_dummy_guid")
+      else
+        note_store.updateNote(token, new_note)
+      end
     logger.debug("done updateNote.")
     create_note_sync_status_file(note_sync_status_path, updated_note, Time.now)
     logger.debug("created: %s" % note_sync_status_path)
@@ -283,10 +244,10 @@ EOS
     note_sync_status = load_yaml_path(note_sync_status_path)
     guid = note_sync_status[:guid]
     logger.debug("doing deleteNote: %s" % guid)
-    note_store.deleteNote(token, guid)
+    note_store.deleteNote(token, guid) if !Synclenote::DRY_RUN
     logger.debug("done deleteNote.")
 
-    note_sync_status_path.delete
+    note_sync_status_path.delete if !Synclenote::DRY_RUN
     logger.debug("removed: %s" % note_sync_status_path)
   end
 end

data/lib/synclenote/configuration.rb

@@ -1,5 +1,3 @@
-require "synclenote"
-
 require "ostruct"
 
 module Synclenote::Configuration

data/lib/synclenote/markdown_to_enml_builder.rb

@@ -0,0 +1,52 @@
+require "nokogiri"
+require "redcarpet"
+
+class Synclenote::MarkdownToEnmlBuilder
+  HEADER = <<~EOS
+    <?xml version="1.0" encoding="UTF-8"?>
+    <!DOCTYPE en-note SYSTEM "http://xml.evernote.com/pub/enml2.dtd">
+    <en-note>
+  EOS
+
+  FOOTER = <<~EOS
+    </en-note>
+  EOS
+
+  class << self
+    def call(markdown_text)
+      formatter = Redcarpet::Markdown.new(
+        Redcarpet::Render::HTML.new(
+          filter_html: true,
+          hard_wrap: true,
+        ),
+        underline: true,
+        lax_spacing: true,
+        footnotes: true,
+        no_intra_emphasis: true,
+        superscript: true,
+        strikethrough: true,
+        tables: true,
+        space_after_headers: true,
+        fenced_code_blocks: true,
+        # autolink: true,
+      )
+      html = formatter.render(markdown_text)
+      root = Nokogiri::HTML::DocumentFragment.parse(html)
+
+      root.css("*[class]").each do |node|
+        node.remove_attribute("class")
+      end
+
+      # '<a href="example.html?foo=bar&baz=quux">'
+      # =>
+      # '<a href="example.html?foo=bar&amp;baz=quux">'
+      treated_html = root.to_html
+      content = [
+        HEADER,
+        treated_html.gsub(/<(br|hr|img).*?>/, "\\&</\\1>"),
+        FOOTER,
+      ].join
+      return content
+    end
+  end
+end

data/lib/synclenote/note_builder.rb

@@ -0,0 +1,41 @@
+module Synclenote::NoteBuilder
+  DEFAULT_TAGS = %w[syncle]
+
+  TITLE_IF_EMPTY = "no title"
+
+  class << self
+    def call(raw_note, guid: nil)
+      lines = raw_note.each_line.lazy
+      title, tags_in_raw_note, body_markdown = *parse_lines(lines)
+      title = TITLE_IF_EMPTY if /\A\s*\z/ === title
+      tags = (DEFAULT_TAGS + tags_in_raw_note).uniq
+      enml = Synclenote::MarkdownToEnmlBuilder.(body_markdown)
+
+      options = {
+        title:,
+        content: enml,
+        tagNames: tags,
+      }
+      options[:guid] = guid if guid
+      return Evernote::EDAM::Type::Note.new(options)
+    end
+
+    private
+
+    def parse_lines(lines)
+      tags = []
+      title = lines.first.chomp.sub(/\A#\s*/, "")
+      lines = lines.drop(1)
+      md = /\A(?<tags>(?:\[.*?\])+)(?:\s|\z)/.match(title)
+      if md
+        tags = md[:tags].scan(/\[(.*?)\]/).flatten
+        title = md.post_match
+      end
+
+      lines = lines.drop_while { |l| /\A\s*\z/ === l }
+      body_markdown = lines.to_a.join
+
+      return [title, tags, body_markdown]
+    end
+  end
+end

data/lib/synclenote/version.rb

@@ -1,3 +1,3 @@
 module Synclenote
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/lib/synclenote.rb

@@ -1,11 +1,14 @@
 # This module is a namespace for this gem.
 module Synclenote
-  autoload :VERSION, "synclenote/varsion"
-
-  autoload :Command, "synclenote/command"
-  autoload :Configuration, "synclenote/configuration"
+  DRY_RUN = false
 
   def self.configure(version, &block)
     Configuration.run(version, &block)
   end
 end
+
+(Pathname(__dir__).glob("**/*.rb") - [Pathname(__FILE__)]).map { |path|
+  path.sub_ext("")
+}.sort.each do |path|
+  require(path.relative_path_from(__dir__))
+end

data/synclenote.gemspec

@@ -24,10 +24,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "base64" # suppress warnings
   spec.add_runtime_dependency "evernote_oauth"
+  spec.add_runtime_dependency "nokogiri"
   spec.add_runtime_dependency "redcarpet"
   spec.add_runtime_dependency "thor"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "debug"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
 end

data/test/lib/synclenote/markdown_to_enml_builder_test.rb

@@ -0,0 +1,58 @@
+require "test_helper"
+
+class Synclenote::MarkdownToEnmlBuilderTest < Test::Unit::TestCase
+  sub_test_case(".call") do
+    data(
+      regular_text: {
+        markdown_text: <<~EOS,
+          body
+        EOS
+        expected_enml_text: <<~EOS,
+          <p>body</p>
+        EOS
+      },
+      fenced_code_blocks: {
+        markdown_text: <<~EOS,
+          ```ruby
+          1 + 2 * 3
+          ```
+        EOS
+        # remove "class" attribute
+        expected_enml_text: <<~EOS,
+          <pre><code>1 + 2 * 3
+          </code></pre>
+        EOS
+      },
+      hard_wrap: {
+        markdown_text: <<~EOS,
+          abc
+          def
+        EOS
+        # convert "<br/>" to "<br></br>"
+        expected_enml_text: <<~EOS,
+          <p>abc<br></br>
+          def</p>
+        EOS
+      },
+      hyperlink: {
+        markdown_text: <<~EOS,
+          [link text](https://example.org/?foo=bar&baz=quux;hoge=fuga#anchor)
+        EOS
+        # convert "&" to "&amp;"
+        expected_enml_text: <<~EOS,
+          <p><a href="https://example.org/?foo=bar&amp;baz=quux;hoge=fuga#anchor">link text</a></p>
+        EOS
+      },
+    )
+    test("returns ENML String") do |h|
+      assert_equal(
+        [
+          Synclenote::MarkdownToEnmlBuilder::HEADER,
+          h[:expected_enml_text],
+          Synclenote::MarkdownToEnmlBuilder::FOOTER,
+        ].join,
+        Synclenote::MarkdownToEnmlBuilder.(h[:markdown_text]),
+      )
+    end
+  end
+end

data/test/lib/synclenote/note_builder_test.rb

@@ -0,0 +1,68 @@
+require "test_helper"
+
+class Synclenote::NoteBuilderTest < Test::Unit::TestCase
+  sub_test_case(".call") do
+    data(
+      regular: {
+        raw_note_text: <<~EOS,
+          # title
+
+          body
+        EOS
+        expected_title: "title",
+        expected_additional_tag_names: [],
+        expected_content_body: <<~EOS,
+          <p>body</p>
+        EOS
+      },
+      no_title: {
+        raw_note_text: <<~EOS,
+          # \t
+
+          body
+        EOS
+        expected_title: Synclenote::NoteBuilder::TITLE_IF_EMPTY,
+        expected_additional_tag_names: [],
+        expected_content_body: <<~EOS,
+          <p>body</p>
+        EOS
+      },
+      have_tags: {
+        raw_note_text: <<~EOS,
+          # [foo][bar-baz] title
+
+          body
+        EOS
+        expected_title: "title",
+        expected_additional_tag_names: %w[foo bar-baz],
+        expected_content_body: <<~EOS,
+          <p>body</p>
+        EOS
+      },
+    )
+    test("returns Note object") do |h|
+      Tempfile.create do |f|
+        f.write(h[:raw_note_text])
+        f.close
+        raw_note_path = Pathname(f.path)
+        note = Synclenote::NoteBuilder.(raw_note_path)
+        assert_equal(h[:expected_title], note.title)
+        assert_equal(
+          [
+            *Synclenote::NoteBuilder::DEFAULT_TAGS,
+            *h[:expected_additional_tag_names],
+          ].sort,
+          note.tagNames.sort,
+        )
+        assert_equal(
+          [
+            Synclenote::MarkdownToEnmlBuilder::HEADER,
+            h[:expected_content_body],
+            Synclenote::MarkdownToEnmlBuilder::FOOTER,
+          ].join,
+          note.content,
+        )
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require "test/unit"
+
+require "synclenote"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: synclenote
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Yuya.Nishida.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-13 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: evernote_oauth
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A synchronization tool for GFM (GitHub Flavored Markdown) files and Evernote.
 email:
 - yuya@j96.org
@@ -103,10 +145,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
@@ -115,8 +157,13 @@ files:
 - lib/synclenote.rb
 - lib/synclenote/command.rb
 - lib/synclenote/configuration.rb
+- lib/synclenote/markdown_to_enml_builder.rb
+- lib/synclenote/note_builder.rb
 - lib/synclenote/version.rb
 - synclenote.gemspec
+- test/lib/synclenote/markdown_to_enml_builder_test.rb
+- test/lib/synclenote/note_builder_test.rb
+- test/test_helper.rb
 homepage: https://github.com/nishidayuya/synclenote
 licenses:
 - X11
@@ -140,4 +187,7 @@ rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A synchronization tool for GFM (GitHub Flavored Markdown) files and Evernote.
-test_files: []
+test_files:
+- test/lib/synclenote/markdown_to_enml_builder_test.rb
+- test/lib/synclenote/note_builder_test.rb
+- test/test_helper.rb

data/Gemfile.lock

@@ -1,49 +0,0 @@
-PATH
-  remote: .
-  specs:
-    synclenote (0.0.1)
-      evernote_oauth
-      redcarpet
-      thor
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    debug (1.6.2)
-      irb (>= 1.3.6)
-      reline (>= 0.3.1)
-    evernote-thrift (1.25.2)
-    evernote_oauth (0.2.3)
-      evernote-thrift
-      oauth (>= 0.4.1)
-    hashie (5.0.0)
-    io-console (0.5.11)
-    irb (1.4.1)
-      reline (>= 0.3.0)
-    oauth (1.1.0)
-      oauth-tty (~> 1.0, >= 1.0.1)
-      snaky_hash (~> 2.0)
-      version_gem (~> 1.1)
-    oauth-tty (1.0.5)
-      version_gem (~> 1.1, >= 1.1.1)
-    rake (13.0.6)
-    redcarpet (3.6.0)
-    reline (0.3.1)
-      io-console (~> 0.5)
-    snaky_hash (2.0.1)
-      hashie
-      version_gem (~> 1.1, >= 1.1.1)
-    thor (1.3.0)
-    version_gem (1.1.3)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  bundler
-  debug
-  rake
-  synclenote!
-
-BUNDLED WITH
-   2.3.10