korgi 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9848cba04694aa95ef726d42866ad3891306361
+  data.tar.gz: 1b633acca87fde4f2b64a4f7db9f057ac39ef8f9
+SHA512:
+  metadata.gz: 2a27d40f74e16d2f86274f67d6cef0763419649d5aaf713a7cc22d5fd3a34b8b977e02f8b8a8f802185656818fc63b709d465aef9d04be7553d5aad0b872d540
+  data.tar.gz: 868a0a9c139f40063b4bcacb863675e9073f3f291cdb6dfbef8ea86a3036e7dd496f41a687178a1d99dd52d73b140cbe2968c575bbddfb2e1938f94fd718852f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Tsehau Chao
+
+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,81 @@
+# Korgi
+
+[HTML::Pipeline](https://github.com/jch/html-pipeline) filters to generate urls for Rails resources with Markdown.
+
+## Usage
+
+### Korgi::FileUploadFilter
+
+```
+# input
+$+image.1$
+
+# filtered result
+uploads/image/file/1/thumb_pic.jpg
+```
+
+*korgi* is meant to work with [CarrierWave](https://github.com/carrierwaveuploader/carrierwave). You will need to tell *korgi* how to map resources for you:
+
+```
+# config/initializers/korgi.rb
+Korgi.configure do |config|
+  config.file_uploads = { image: [Image, :file, :thumb] }
+end
+```
+
+This tells *korgi* that you have a CarrierWave uploader mounted to `Image:file`, with `:thumb` as it's default version. You can then simply write `$+image.1$` or `$+image.1.large$` in your markdown input, and *korgi* will replace the syntax with the associated url (and version).
+
+If you need the full url instead, you should change the settings for CarrierWave:
+
+```
+CarrierWave.configure do |config|
+  config.asset_host = "http://awesome.host.com"
+end
+```
+
+### Korgi::NamedRouteFilter
+
+```
+# input
+$#post.1$
+
+# filtered result
+/admin/posts/1
+```
+
+You will need to tell *korgi* how to map resouces for you:
+
+```
+# config/initializers/korgi.rb
+Korgi.configure do |config|
+  config.named_routes = { post: "admin/posts" }
+end
+```
+
+*korgi* will then be able to replace `$#post.1$` with the result of `admin_post_path(1)`.
+
+### putting it all together
+
+I tried to keep *korgi* simple, so you will still need to render the markdown syntax. Please do check out the documentation for [HTML::Pipeline](https://github.com/jch/html-pipeline). Here is an example snippet:
+
+```
+pipeline =
+  HTML::Pipeline.new [
+    Korgi::FileUploadFilter,
+    Korgi::NamedRouteFilter,
+    HTML::Pipeline::MarkdownFilter
+  ]
+result = pipeline.call <<-EOD
+This is a [link to post1]($#post.1$).
+EOD
+result[:output].to_s
+
+=>
+<p>This is a <a href="/admin/posts/1">link to post1</a>.</p>
+```
+
+## Contributing
+Send me a PR!
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/korgi/config.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require "active_support/configurable"
+module Korgi
+  include ActiveSupport::Configurable
+  config.instance_eval do
+    self.named_routes = {} # { post: "dashboard/posts" }
+    self.file_uploads = {} # { image: [Image, :file, :thumb] }
+  end
+end

data/lib/korgi/engine.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require "rails/engine"
+require "carrierwave"
+require "mini_magick"
+module Korgi
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/korgi/file_upload_filter.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require "html/pipeline"
+module Korgi
+  class FileUploadFilter < ::HTML::Pipeline::Filter
+    def initialize(doc, context = nil, result = nil)
+      super doc, context, result
+      @klass, @mount, @version = nil
+    end
+
+    def call
+      doc.to_s.gsub(pattern) { replace(Regexp.last_match) }
+    end
+
+    private
+
+    def replace(matches)
+      result, model, id, version = matches.to_a
+      @klass, @mount, @version = Korgi.config.file_uploads[model.to_sym]
+      version ||= @version
+      @klass.find(id).send(@mount).url(file_version(version))
+    rescue ActiveRecord::RecordNotFound, NameError
+      result
+    end
+
+    def file_version(version)
+      if valid_file_version?(version)
+        version
+      else
+        @version
+      end
+    end
+
+    def valid_file_version?(version)
+      file_versions.include?(version.to_sym)
+    end
+
+    def file_versions
+      @klass.uploaders[@mount].versions.keys
+    end
+
+    def pattern
+      %r{\$\+([\w]+).([\d]+)(?:.([\w]+))?\$}
+    end
+  end
+end

data/lib/korgi/named_route_filter.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require "rails/all"
+require "html/pipeline"
+module Korgi
+  class NamedRouteFilter < ::HTML::Pipeline::Filter
+    include ActionView::Helpers
+    include Rails.application.routes.url_helpers
+
+    def initialize(doc, context = nil, result = nil)
+      super doc, context, result
+    end
+
+    def call
+      doc.to_s.gsub(pattern) { replace(Regexp.last_match) }
+    end
+
+    private
+
+    def replace(matches)
+      result, model, id = matches.to_a
+      url_for(controller: Korgi.config.named_routes[model.to_sym], action: "show", id: id, only_path: true)
+    rescue ActionController::UrlGenerationError
+      result
+    end
+
+    def pattern
+      %r{\$#([\w]+).([\d]+)\$}
+    end
+  end
+end

data/lib/korgi/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require "rails/railtie"
+module Korgi
+  class Railtie < ::Rails::Railtie
+    config.after_initialize do
+      require "korgi/named_route_filter"
+      require "korgi/file_upload_filter"
+    end
+  end
+end

data/lib/korgi/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Korgi
+  VERSION = "0.1.1"
+end

data/lib/korgi.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+require "korgi/engine"
+require "korgi/railtie"
+require "korgi/config"
+module Korgi
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: korgi
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tsehau Chao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+description: Extends the Markdown syntax to allow quick generation of links to Rails
+  resources.
+email:
+- jodeci@5xruby.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/korgi.rb
+- lib/korgi/config.rb
+- lib/korgi/engine.rb
+- lib/korgi/file_upload_filter.rb
+- lib/korgi/named_route_filter.rb
+- lib/korgi/railtie.rb
+- lib/korgi/version.rb
+homepage: https://github.com/jodeci/korgi
+licenses:
+- MIT
+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.6
+signing_key: 
+specification_version: 4
+summary: Markdown filter for Rails resources
+test_files: []