middleman-somemoji 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e83faa87fdbd3b98f50bdf215a020a50c5ee91b
+  data.tar.gz: 4a54349e7e1b6463495751699024e18027bcdb31
+SHA512:
+  metadata.gz: 07ca8da3361ad0f52c3b0d7c419ae1796a342e4a49dc16f3b7389972611d738a6e4788c244a1816eff9bcb1639a60b969d7cb1a151aa02435640de92a5b8617c
+  data.tar.gz: 1a66fc18791914a2965bed4f847469337332db09bf1ed0bb20fd65ff9765579d1feebd0a3752108c6e5aa4dc606d4d8e17729f0fda51c11402055089179e989d

data/.gitignore

@@ -0,0 +1,7 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+tmp/

data/.travis.yml

@@ -0,0 +1,10 @@
+notifications:
+  email: false
+sudo: false
+language: ruby
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+  - ruby-head
+before_install: gem install bundler -v 1.14.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-somemoji.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yusuke Nakamura
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# middleman-somemoji
+
+[![Build Status](https://travis-ci.org/unasuke/middleman-somemoji.svg?branch=master)](https://travis-ci.org/unasuke/middleman-somemoji)
+
+middleman-somemoji is a emoji extension for Middleman.
+
+Choose emoji provider and convert emoji shorthand (e.g. `:heart:`) to `<img>` tag using somemoji gem.
+
+## usage
+### 1. bundle install
+
+```ruby
+# Gemfile
+source 'https://rubygems.org'
+
+gem 'middleman', '>= 4.0.0'
+gem 'middleman-somemoji'
+```
+
+and run `bundle install`
+
+### 2. download emoji images
+
+Download emoji images to your middleman images directory using somemoji gem.
+
+```shell
+# in your middleman root directory (destination path is a example)
+$ bundle exec somemoji extract --provider=twemoji --destination=./source/images/emoji
+```
+
+See also somemoji's readme → [somemoji/README.md](https://github.com/r7kamura/somemoji/blob/master/README.md)
+
+### 3. activate somemoji extension and setting it
+
+```ruby
+# your middleman config.rb
+activate :somemoji,
+  provider:    'twemoji',
+  emojis_dir:  '/images/emoji'
+```
+
+:warning: __note__ :warning:
+
+If you using `asset_hash` extension, currentry disable it in emoji images directory please :pray:
+
+```ruby
+# for example
+activate :asset_hash, ignore: 'images/twemoji'
+```
+
+### 4. write emoji shorthand
+
+examples...
+
+```markdown
+# my markdown document
+I'm happy :lauging:
+
+## but
+So sorry... :bow:
+```
+
+```slim
+h1 my slim document
+div.some-class
+  p
+    | :eyes:
+  small
+    | :+1:
+```
+
+See also [Emoji cheat sheet for GitHub, Basecamp and other services](https://www.webpagefx.com/tools/emoji-cheat-sheet/)
+
+### 5. build middleman site!
+
+```shell
+$ bundle exec middleman build
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/unasuke/middleman-somemoji.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Reference
+- [r7kamura/somemoji: A grand unified emoji mapper for some emoji providers.](https://github.com/r7kamura/somemoji)

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/emoji.feature

@@ -0,0 +1,9 @@
+Feature: Emoji
+  Scenario: Should convert :heart: to img tag
+    Given a fixture app "emoji-app"
+    And the Server is running at "emoji-app"
+    When I go to "/index.html"
+    Then I should see "❤️"
+    Then I should see "emoji"
+    Then I should see "/images/emoji/unicode/2764-fe0f.png"
+    #Then I should see %(img alt="❤️" class="emoji" src="/images/emoji/unicode/2764-fe0f.png")

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-somemoji')

data/features/twemoji.feature

@@ -0,0 +1,8 @@
+Feature: Twemoji
+  Scenario: Should convert :smile: to img tag
+    Given a fixture app "twemoji-app"
+    And the Server is running at "twemoji-app"
+    When I go to "/index.html"
+    Then I should see "😄"
+    Then I should see "twemoji"
+    Then I should see "/images/twemoji/unicode/1f604.svg"

data/fixtures/emoji-app/config.rb

@@ -0,0 +1 @@
+activate :somemoji

data/fixtures/emoji-app/source/index.html.erb

@@ -0,0 +1 @@
+<p>:heart:</p>

data/fixtures/emoji-app/source/layout.erb

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Test App</title>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/fixtures/twemoji-app/config.rb

@@ -0,0 +1,6 @@
+activate :somemoji,
+  provider:    'twemoji',
+  format:      'svg',
+  emoji_class: 'twemoji',
+  emojis_dir:  '/images/twemoji'
+

data/fixtures/twemoji-app/source/index.html.erb

@@ -0,0 +1 @@
+<p>:smile:</p>

data/fixtures/twemoji-app/source/layout.erb

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Test App</title>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/lib/middleman-somemoji.rb

@@ -0,0 +1,6 @@
+require 'middleman-core'
+
+Middleman::Extensions.register :somemoji do
+  require 'middleman-somemoji/extension'
+  ::Middleman::Somemoji::Extension
+end

data/lib/middleman-somemoji/converter.rb

@@ -0,0 +1,21 @@
+require 'somemoji'
+
+module Middleman
+  module Somemoji
+    class Converter
+      def initialize(body, options)
+        @body         = body
+        @provider     = options[:provider]
+        @format       = options[:format]
+        @emoji_class  = options[:emoji_class]
+        @emojis_dir   = options[:emojis_dir]
+      end
+
+      def convert
+        eval("::Somemoji::#{@provider}_emoji_collection").replace_code(@body) do |emoji|
+          %(<img alt="#{emoji.character}" class="#{@emoji_class}" src="#{@emojis_dir}/#{emoji.base_path}.#{@format}">)
+        end
+      end
+    end
+  end
+end

data/lib/middleman-somemoji/extension.rb

@@ -0,0 +1,25 @@
+require 'middleman-core'
+require 'middleman-somemoji/converter'
+
+module Middleman
+  module Somemoji
+    class Extension < ::Middleman::Extension
+      option :provider,     'apple',         %[Emoji provider (default is 'apple')]
+      option :format,       'png',           %[Emoji format (default is 'png')]
+      option :emoji_class,  'emoji',         %[<img> tag class (default is 'emoji')]
+      option :emojis_dir,   '/images/emoji', %[Emoji images directory path (default is '/images/emoji')]
+
+      def initialize(app, options_hash={}, &block)
+        super
+
+        require 'somemoji'
+
+        @options = options
+
+        app.before_render do |body, path, locs, template_class|
+          ::Middleman::Somemoji::Converter.new(body, @options).convert
+        end
+      end
+    end
+  end
+end

data/lib/middleman-somemoji/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Somemoji
+    VERSION = '0.1.0'.freeze
+  end
+end

data/middleman-somemoji.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-somemoji/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'middleman-somemoji'
+  s.version     = Middleman::Somemoji::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Yusuke Nakamura']
+  s.email       = ['yusuke1994525@gmail.com']
+  s.homepage    = 'https://github.com/unasuke/middleman-somemoji'
+  s.summary     = %q{Convert emoji (e.g. :heart:) to <img> tag.}
+  s.description = %q{Choose emoji provider and convert emoji shorthand to <img> tag using somemoji gem.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+  
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency 'middleman-core', '>= 4'
+  s.add_runtime_dependency 'somemoji'
+
+  s.add_development_dependency 'bundler', '~> 1.14'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rdoc'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: middleman-somemoji
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yusuke Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: somemoji
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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: yard
+  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: cucumber
+  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: capybara
+  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: aruba
+  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: rspec
+  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: Choose emoji provider and convert emoji shorthand to <img> tag using
+  somemoji gem.
+email:
+- yusuke1994525@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/emoji.feature
+- features/support/env.rb
+- features/twemoji.feature
+- fixtures/emoji-app/config.rb
+- fixtures/emoji-app/source/index.html.erb
+- fixtures/emoji-app/source/layout.erb
+- fixtures/twemoji-app/config.rb
+- fixtures/twemoji-app/source/index.html.erb
+- fixtures/twemoji-app/source/layout.erb
+- lib/middleman-somemoji.rb
+- lib/middleman-somemoji/converter.rb
+- lib/middleman-somemoji/extension.rb
+- lib/middleman-somemoji/version.rb
+- middleman-somemoji.gemspec
+homepage: https://github.com/unasuke/middleman-somemoji
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Convert emoji (e.g. :heart:) to <img> tag.
+test_files:
+- features/emoji.feature
+- features/support/env.rb
+- features/twemoji.feature