korgi 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9848cba04694aa95ef726d42866ad3891306361
-  data.tar.gz: 1b633acca87fde4f2b64a4f7db9f057ac39ef8f9
+  metadata.gz: 050e5bb1bab1f7c286154c1c1100e0f5a8bcf268
+  data.tar.gz: dbe4c158ab61265306ac2d43342be42232534363
 SHA512:
-  metadata.gz: 2a27d40f74e16d2f86274f67d6cef0763419649d5aaf713a7cc22d5fd3a34b8b977e02f8b8a8f802185656818fc63b709d465aef9d04be7553d5aad0b872d540
-  data.tar.gz: 868a0a9c139f40063b4bcacb863675e9073f3f291cdb6dfbef8ea86a3036e7dd496f41a687178a1d99dd52d73b140cbe2968c575bbddfb2e1938f94fd718852f
+  metadata.gz: 272aabc24cb3f2de3815655a3c658e9c745c04bd8b16a2b7ee2c139669a9b10b5eedd083563eb7b1670115c2b4e93b0639b1459663da976b656fccf38bc60d9b
+  data.tar.gz: 18951b599032c7238fbaed538c85cdba45d29d7a1dada65ce9da3d43effb34a5cb961af4a69c386fd242d5de6c72118d63a9607fcc7ec794b56556dea34cc0c8

data/README.md

@@ -1,6 +1,11 @@
 # Korgi
 
-[HTML::Pipeline](https://github.com/jch/html-pipeline) filters to generate urls for Rails resources with Markdown.
+[![Gem Version](https://badge.fury.io/rb/korgi.svg)](https://badge.fury.io/rb/korgi)
+[![Code Climate](https://codeclimate.com/github/jodeci/korgi/badges/gpa.svg)](https://codeclimate.com/github/jodeci/korgi)
+[![Test Coverage](https://codeclimate.com/github/jodeci/korgi/badges/coverage.svg)](https://codeclimate.com/github/jodeci/korgi/coverage)
+[![Build Status](https://travis-ci.org/jodeci/korgi.svg?branch=master)](https://travis-ci.org/jodeci/korgi)
+
+[html-pipeline](https://github.com/jch/html-pipeline) filters to generate urls for Rails resources.
 
 ## Usage
 
@@ -11,7 +16,7 @@
 $+image.1$
 
 # filtered result
-uploads/image/file/1/thumb_pic.jpg
+/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:
@@ -19,18 +24,22 @@ uploads/image/file/1/thumb_pic.jpg
 ```
 # config/initializers/korgi.rb
 Korgi.configure do |config|
-  config.file_uploads = { image: [Image, :file, :thumb] }
+  config.file_uploads = { image: { model: Image, mount: :file, default_version: :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).
+This tells *korgi* that you have a CarrierWave uploader mounted to `Image` on `:file`, with `:thumb` as its 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:
 
 ```
+# config/initializers/carrierwave.rb
 CarrierWave.configure do |config|
   config.asset_host = "http://awesome.host.com"
 end
+
+# filtered result
+http://awesome.host.com/uploads/image/file/1/thumb_pic.jpg
 ```
 
 ### Korgi::NamedRouteFilter
@@ -40,7 +49,7 @@ end
 $#post.1$
 
 # filtered result
-/admin/posts/1
+/posts/1
 ```
 
 You will need to tell *korgi* how to map resouces for you:
@@ -48,15 +57,24 @@ 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" }
+  config.named_routes = { post: { controller: :posts } }
+end
+```
+
+In Rails speak, this means that *korgi* will replace  `$#post.1$` with the result of `post_path(id: 1)`. If you are using [FriendlyId](https://github.com/norman/friendly_id) to create url slugs, you can also do this:
+
+```
+# config/initializers/korgi.rb
+Korgi.configure do |config|
+  config.named_routes = { post: { controller: :posts, model: Post, primary_key: :slug } }
 end
 ```
 
-*korgi* will then be able to replace `$#post.1$` with the result of `admin_post_path(1)`.
+This will enable *korgi* to interpret `$#post.1$` as `post_path(id: Post.find(1).slug)` instead, and will then return the slugged url, e,g, `/posts/slug-url`.
 
 ### 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:
+I tried to keep *korgi* simple, so it only generates the link, not the entire html. You will most likely be using *korgi* along Markdown, but I'll leave that decision to you. Please do check out the documentation for [html-pipeline](https://github.com/jch/html-pipeline) on how to render Markdown content. Here is an example snippet:
 
 ```
 pipeline =
@@ -67,11 +85,13 @@ pipeline =
   ]
 result = pipeline.call <<-EOD
 This is a [link to post1]($#post.1$).
+Here is an [image]($+image.1$).
 EOD
 result[:output].to_s
 
 =>
-<p>This is a <a href="/admin/posts/1">link to post1</a>.</p>
+<p>This is a <a href="/posts/1">link to post1</a>.</p>
+<p>Here is an <img src="/uploads/image/file/1/thumb_pic.jpg" alt="image">.</p>
 ```
 
 ## Contributing

data/lib/korgi/config.rb

@@ -3,7 +3,7 @@ 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] }
+    self.named_routes = {} # { post: { controller: :posts, model: Post, primary_key: :slug } }
+    self.file_uploads = {} # { image: { model: Image, mount: :file, default_version: :thumb, nil_object: NullImage } }
   end
 end

data/lib/korgi/engine.rb

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

data/lib/korgi/file_object.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Korgi
+  class FileObject
+    attr_reader :klass, :id, :nil_object
+
+    def initialize(klass, id, nil_object)
+      @klass = klass
+      @id = id
+      @nil_object = nil_object
+    end
+
+    def fetch
+      klass.find(id)
+    rescue ActiveRecord::RecordNotFound, NameError
+      nil_object || Korgi::NullFileObject
+    end
+  end
+
+  class NullFileObject
+    class << self
+      def url(_version)
+        nil
+      end
+    end
+  end
+end

data/lib/korgi/file_upload_filter.rb

@@ -1,45 +1,70 @@
 # frozen_string_literal: true
 require "html/pipeline"
+require "korgi/file_object"
 module Korgi
   class FileUploadFilter < ::HTML::Pipeline::Filter
+    attr_reader :target, :id, :version
+
     def initialize(doc, context = nil, result = nil)
       super doc, context, result
-      @klass, @mount, @version = nil
+      @target, @id, @version = nil
     end
 
     def call
-      doc.to_s.gsub(pattern) { replace(Regexp.last_match) }
+      doc.to_s.gsub(pattern) do
+        origin, @target, @id, @version = Regexp.last_match.to_a
+        valid_target? ? file_url : origin
+      end
     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
+    def pattern
+      %r{\$\+([\w]+).([\d]+)(?:.([\w]+))?\$}
+    end
+
+    def file_url
+      Korgi::FileObject.new(klass, id, nil_object).fetch.send(mount).url(file_version)
+    end
+
+    def valid_target?
+      Korgi.config.file_uploads.key?(target.to_sym)
+    end
+
+    def configured_value(key)
+      Korgi.config.file_uploads[target.to_sym][key]
+    end
+
+    def klass
+      configured_value(:model)
+    end
+
+    def mount
+      configured_value(:mount)
     end
 
-    def file_version(version)
-      if valid_file_version?(version)
-        version
+    def nil_object
+      configured_value(:nil_object)
+    end
+
+    def default_version
+      configured_value(:default_version)
+    end
+
+    def file_version
+      if version
+        valid_file_version? ? version : default_version
       else
-        @version
+        default_version
       end
     end
 
-    def valid_file_version?(version)
+    def valid_file_version?
       file_versions.include?(version.to_sym)
     end
 
     def file_versions
-      @klass.uploaders[@mount].versions.keys
-    end
-
-    def pattern
-      %r{\$\+([\w]+).([\d]+)(?:.([\w]+))?\$}
+      klass.uploaders[mount].versions.keys
     end
   end
 end

data/lib/korgi/named_route_filter.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
-require "rails/all"
 require "html/pipeline"
 module Korgi
   class NamedRouteFilter < ::HTML::Pipeline::Filter
+    attr_reader :target, :id
+
     include ActionView::Helpers
     include Rails.application.routes.url_helpers
 
     def initialize(doc, context = nil, result = nil)
       super doc, context, result
+      @target, @id = nil
     end
 
     def call
@@ -16,15 +18,45 @@ module Korgi
 
     private
 
+    def pattern
+      %r{\$#([\w]+).([\d]+)\$}
+    end
+
     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)
+      origin, @target, @id = matches.to_a
+      valid_target? ? resource_url : origin
     rescue ActionController::UrlGenerationError
-      result
+      origin
     end
 
-    def pattern
-      %r{\$#([\w]+).([\d]+)\$}
+    def resource_url
+      url_for(controller: controller, action: "show", id: find_object, only_path: true)
+    end
+
+    def find_object
+      primary_key == :id ? id : klass.find(id).send(primary_key)
+    rescue ActiveRecord::RecordNotFound
+      id
+    end
+
+    def valid_target?
+      Korgi.config.named_routes.key?(target.to_sym)
+    end
+
+    def configured_value(key)
+      Korgi.config.named_routes[target.to_sym][key]
+    end
+
+    def controller
+      configured_value(:controller)
+    end
+
+    def klass
+      configured_value(:model)
+    end
+
+    def primary_key
+      configured_value(:primary_key) || :id
     end
   end
 end

data/lib/korgi/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: korgi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Tsehau Chao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-04 00:00:00.000000000 Z
+date: 2017-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !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:
@@ -94,6 +80,7 @@ files:
 - lib/korgi.rb
 - lib/korgi/config.rb
 - lib/korgi/engine.rb
+- lib/korgi/file_object.rb
 - lib/korgi/file_upload_filter.rb
 - lib/korgi/named_route_filter.rb
 - lib/korgi/railtie.rb