slackdown 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d49f22b8415c9c1a5ec398e77946869bd33c05b
-  data.tar.gz: 4d5c1138a3c6fc11cfab331da83b9ec6eef5b179
+  metadata.gz: 499a5d5c98091cf1fb577d6591bec17e43e53572
+  data.tar.gz: 426aa1d4a1b48092407c02dd4455b8fb86bd7add
 SHA512:
-  metadata.gz: f532e9fe55ba4de25809ae3d4647ba6bf63b098695adddae8a883ac97dd74f28c1de8bf49bd1d904ebe4d42168eb035bab513a2fb992fee4b140770dcb767586
-  data.tar.gz: e42f6d301fe0fd57f92ec838ab334c31b03d067ba3967ef9e1cc63e564864f9702f4c192005346ae77f6ff51ea63891847c5ca7dc3aff43bfbac1e5298140053
+  metadata.gz: 10543ed1151084a83cab220a941cd47431b84abe8b3a1a23f67d249b9b858ba1aed870686e89fd2c868c82dabd49e3d07c881aadf195eeeb16f087495c83c8bb
+  data.tar.gz: 4190b88e6ec41752821920143262048fd59c4459d017b29ae8fc56049e74bb067cd48808268103d566466b54e47a90b153da8c91613773b7028991110857cbea

data/README.md

@@ -1,28 +1,26 @@
 # Slackdown
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/slackdown`. To experiment with that code, run `bin/console` for an interactive prompt.
+Slackdown converts Markdown to [Slack's simpler markup syntax](https://get.slack.help/hc/en-us/articles/202288908-How-can-I-add-formatting-to-my-messages-).
 
-TODO: Delete this and the text above, and describe your gem
+Slackdown implements a converter for [kramdown](https://github.com/gettalong/kramdown).
 
-## Installation
 
-Add this line to your application's Gemfile:
+## Usage
 
 ```ruby
-gem 'slackdown'
-```
-
-And then execute:
+require "slackdown"
 
-    $ bundle
+Slackdown.convert(markdown_text)
+```
 
-Or install it yourself as:
+If you're familiar with Kramdown, you can also do:
 
-    $ gem install slackdown
+```ruby
+require "kramdown/converter/slack"
 
-## Usage
+Kramdown::Document.new(markdown_text, options).to_slack
+```
 
-TODO: Write usage instructions here
 
 ## Development
 
@@ -30,12 +28,12 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/slackdown.
+Bug reports and pull requests are welcome on GitHub at https://github.com/houston/slackdown.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/kramdown/converter/slack.rb

@@ -0,0 +1,183 @@
+module Kramdown
+  module Converter
+
+    # Converts a Kramdown::Document to Slack.
+    # https://api.slack.com/docs/message-formatting
+    class Slack < Base
+
+      def convert(el)
+        if el.type == :html_element
+          converter = :"convert_html_#{el.value}"
+          converter = :convert_html_element unless respond_to? converter
+        else
+          converter = :"convert_#{el.type}"
+        end
+        send(converter, el)
+      end
+
+      def inner(el)
+        el.children.map { |el| convert(el) }.join
+      end
+      alias :convert_root :inner
+
+      def convert_p(el)
+        "#{inner(el).strip.gsub(/\n/, " ")}\n\n"
+      end
+
+      def convert_text(el)
+        el.value
+      end
+      alias :convert_abbreviation :convert_text
+
+      def convert_blank(el)
+        ""
+      end
+      alias :convert_br :convert_blank
+      alias :convert_comment :convert_blank
+
+      def convert_html_br(el)
+        "\n"
+      end
+
+      def convert_strong(el)
+        "*#{inner(el)}*"
+      end
+      alias :convert_html_b :convert_strong
+      alias :convert_html_strong :convert_strong
+
+      def convert_em(el)
+        "_#{inner(el)}_"
+      end
+      alias :convert_html_i :convert_em
+      alias :convert_html_em :convert_em
+
+      def convert_del(el)
+        "~#{inner(el)}~"
+      end
+      alias :convert_html_del :convert_del
+
+      def convert_codespan(el)
+        "`#{el.value}`"
+      end
+      alias :convert_html_code :convert_codespan
+
+      def convert_blockquote(el)
+        "> #{inner(el)}"
+      end
+
+      def convert_codeblock(el)
+        "```\n#{el.value}```"
+      end
+
+      def convert_a(el)
+        el.attr["href"]
+      end
+      alias :convert_html_a :convert_a
+
+      def convert_img(el)
+        el.attr["src"]
+      end
+      alias :convert_html_img :convert_img
+
+      def convert_ul(el)
+        @bullet = UlBulletGenerator.new
+        "#{inner(el)}\n"
+      end
+      alias :convert_html_ul :convert_ul
+
+      def convert_ol(el)
+        @bullet = OlBulletGenerator.new
+        "#{inner(el)}\n"
+      end
+      alias :convert_html_ol :convert_ol
+
+      def convert_li(el)
+        "  #{bullet.next} #{inner(el).strip}\n"
+      end
+      alias :convert_html_li :convert_li
+
+      def convert_header(el)
+        "\n\n#{convert_strong(el)}\n"
+      end
+      alias :convert_html_h1 :convert_header
+      alias :convert_html_h2 :convert_header
+      alias :convert_html_h3 :convert_header
+      alias :convert_html_h4 :convert_header
+      alias :convert_html_h5 :convert_header
+      alias :convert_html_h6 :convert_header
+
+      def convert_hr(el)
+        "----------------------------------------------\n\n"
+      end
+
+      def convert_smart_quote(el)
+        SMART_QUOTES.fetch(el.value)
+      end
+
+      def convert_typographic_sym(el)
+        TYPOGRAPHIC_SYMBOLS.fetch(el.value)
+      end
+
+      def convert_entity(el)
+        ENTITIES.fetch(el.options[:original])
+      end
+
+
+
+      def __convert_todo(el)
+        inner(el)
+      end
+      alias :convert_html_element :__convert_todo
+
+      # The following are all tags converted by Kramdown::Converter::Html
+      alias :convert_dd :__convert_todo
+      alias :convert_dl :__convert_todo
+      alias :convert_dt :__convert_todo
+      alias :convert_footnote :__convert_todo
+      alias :convert_math :__convert_todo
+      alias :convert_raw :__convert_todo
+      alias :convert_table :__convert_todo
+      alias :convert_tbody :__convert_todo
+      alias :convert_td :__convert_todo
+      alias :convert_tfoot :__convert_todo
+      alias :convert_thead :__convert_todo
+      alias :convert_tr :__convert_todo
+      alias :convert_xml_comment :__convert_todo
+      alias :convert_xml_pi :__convert_todo
+
+    private
+      attr_reader :bullet
+
+      class UlBulletGenerator
+        def next; "• "; end
+      end
+
+      class OlBulletGenerator
+        def initialize; @i = 0; end
+        def next; "#{@i += 1}."; end
+      end
+
+      SMART_QUOTES = {
+        lsquo: "‘",
+        rsquo: "’",
+        ldquo: "“",
+        rdquo: "”" }.freeze
+
+      TYPOGRAPHIC_SYMBOLS = {
+        mdash: "—",
+        ndash: "–",
+        hellip: "...",
+        laquo_space: "« ",
+        raquo_space: " »",
+        laquo: "«",
+        raquo: "»" }.freeze
+
+      ENTITIES = {
+        "&lt;" => "<",
+        "&gt;" => ">",
+        "&amp;" => "&",
+        "&quot;" => "\"" }.freeze
+
+    end
+  end
+end

data/lib/slackdown.rb

@@ -1,5 +1,11 @@
 require "slackdown/version"
+require "kramdown"
+require "kramdown/converter/slack"
 
 module Slackdown
-  # Your code goes here...
+
+  def self.convert(markdown, options={})
+    Kramdown::Document.new(markdown, options).to_slack
+  end
+
 end

data/lib/slackdown/version.rb

@@ -1,3 +1,3 @@
 module Slackdown
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/slackdown.gemspec

@@ -19,7 +19,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "kramdown", "~> 1.13.2"
+
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "minitest-reporters-turn_reporter"
+  spec.add_development_dependency "shoulda-context"
+  spec.add_development_dependency "pry"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: slackdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-30 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters-turn_reporter
+  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'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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 converter for Kramdown that converts GitHub-Flavored Markdown to Slack's
   simplified Markdown
 email:
@@ -68,6 +138,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/kramdown/converter/slack.rb
 - lib/slackdown.rb
 - lib/slackdown/version.rb
 - slackdown.gemspec