md2key 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 715e0b41ecbfdbb4b7bd47471b3869361fdf12a4
-  data.tar.gz: 4aa12b0da58a5571dba5bbf57844d5b6b536274c
+  metadata.gz: 9344258d896f70f623b6297cd04a23d5f89dfd4c
+  data.tar.gz: 21aecf4aee086196aac28d1ddb49b519e86d8375
 SHA512:
-  metadata.gz: 0b8459ae62e7adeaf6f57757d0d1420ac18106a0d13320ef581d454d16cdb767c547ae22b1d7f49b5bf9c4f2664c78d2f14d43877b2bf735ac0d823d7a9d7d07
-  data.tar.gz: 00219c993468952728073684d4051b2d41eae58594255fba50500ba17da89234debdf49fb068a38f3d468a54cb9ec009edeff2ef3e273eb2e5feaa8c62a7280e
+  metadata.gz: 0e99d47cfe441d711a6a3bf5de5214df354b3b1a291a902679acfb2ada90ecf59613fc72dac76588a16dded595bf36a2239c82f41f2719d3ad9e5dd38737b26b
+  data.tar.gz: cfda1467a4bd799182cc7955420512fbe2d457716227fc52b740ce12fe5459ae12cc4e5cc9da3f4ca73a1d0d9dae8211e1d363683461d4a3a598767ba1e5b0f9

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# v0.2.0
+
+- Use redcarpet as markdown parser
+  - Support `*` list
+
+# v0.1.2
+
+- Temporarily support skipping `---`
+  - Still expecting users to write a format like Deckset
+  - https://github.com/k0kubun/md2key/pull/2
+
+# v0.1.1
+
+- Fix strange indentation
+  - https://github.com/k0kubun/md2key/issues/1
+
+# v0.1.0
+
+- Initial release
+  - Parse only `#`, `-` and `---`

data/lib/md2key/markdown.rb

@@ -1,37 +1,62 @@
+require 'redcarpet'
+require 'oga'
+
+# Parse markdown, generate AST and convert it to slides.
+# This is created to be compatible with Deckset.
+# See: http://www.decksetapp.com/cheatsheet/
 module Md2key
   class Markdown
     def initialize(path)
-      @markdown = File.read(path)
+      markdown = File.read(path)
+      xhtml    = to_xhtml(markdown)
+      @ast     = Oga.parse_xml(xhtml)
     end
 
     def slides
-      @slides ||= parse_markdown
+      @slides ||= generate_slides
     end
 
     private
 
-    def parse_markdown
+    def generate_slides
       slides = []
       slide  = Slide.new
 
-      @markdown.each_line do |line|
-        line = line.strip
-        case line
-        when /^--+$/
-          # noop
-        when /^# *(.+)$/
+      @ast.children.each do |node|
+        next unless node.is_a?(Oga::XML::Element)
+
+        case node.name
+        when /^h[1-9]$/
+          # New slide by header. You can skip to write `---`.
+          # This feature will be removed in the future to provide
+          # more compatibility with Deckset.
+          # See: https://github.com/k0kubun/md2key/pull/2
+          if slides.any?
+            slide = Slide.new
+          end
+
           slides << slide
-          slide = Slide.new
-          slide.title = $1
-        when /^- *(.+)$/
-          slide.lines << $1
-        else
-          slide.lines << line unless line.empty?
+          slide.title = node.text
+        when 'ul'
+          node.children.each do |child_node|
+            next unless child_node.is_a?(Oga::XML::Element)
+            next if child_node.name != 'li'
+
+            # TODO: implement nested list
+            slide.lines << child_node.inner_text.strip
+          end
+        when 'p'
+          slide.lines << node.text
+        when 'hr'
+          # noop
         end
       end
-      slides << slide
-      slides.shift unless slides.empty?
       slides
     end
+
+    def to_xhtml(markdown)
+      redcarpet = Redcarpet::Markdown.new(Redcarpet::Render::XHTML)
+      redcarpet.render(markdown)
+    end
   end
 end

data/lib/md2key/version.rb

@@ -1,3 +1,3 @@
 module Md2key
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/md2key.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "thor", "~> 0.19"
   spec.add_dependency "unindent", "~> 1.0"
+  spec.add_dependency "redcarpet", "~> 3.3"
+  spec.add_dependency "oga", "~> 1.2"
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "pry"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: md2key
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Takashi Kokubun
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: oga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -89,7 +117,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.10.6