fixer_upper 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd048ff747c17e9b203c63f89ba9c39ac1d7894b
-  data.tar.gz: ad1cf61e1c489d37519618782692f3c42db748d6
+  metadata.gz: 0bcbce16e5c4f9fb5a1b5d78322f9b2241c465b5
+  data.tar.gz: 51eb5aa25ae838861ab386c763d69568a94e391a
 SHA512:
-  metadata.gz: fccbaf7810c6ef7f114f7021afa0b0e7f5075d1bcfbf3206411b37baa1b62272612320deec52dcdc14477b3b4dd2985044be915dffc2b47f2f9e8d83439d6d23
-  data.tar.gz: 92b70790d2bda9592d21a4bb7a8fdd256a3e741be62e13802140238b566dab186afb0cdf3ccc16aea84ce1ce48893f634d043a2bbbf787f0aa3c083085bed7e4
+  metadata.gz: 677fa1150394d40b81d7c158d248d61766dda95ba18099434e7f4ef578a9f0d0f3c780c2b742a91f1a38fed7a5c73a261a48b27dfd8a4ef9ea486b34448d5886
+  data.tar.gz: 2169743b4cd1dd240adaea91eec433a0ac3594a661ab4fcad5ca7b9a1c87642f2ffcd7430e4ca05d8a37633c9de32427163d52895b440af7b085c44882ce10ce

data/.rubocop.yml

@@ -1,55 +1,5 @@
-AllCops:
-  DisplayCopNames: true
+inherit_gem:
+  the_bath_of_zahn: rubocop.yml
 
-Bundler/OrderedGems:
+Metrics/ParameterLists:
   Enabled: false
-
-Metrics/LineLength:
-  IgnoredPatterns:
-    - !ruby/regexp /^\s*#/
-
-Metrics/MethodLength:
-  Exclude:
-    - test/**/*.rb
-
-Style/AlignParameters:
-  EnforcedStyle: with_fixed_indentation
-
-Style/AsciiComments:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/EmptyMethod:
-  Enabled: false
-
-Style/ExtraSpacing:
-  AllowForAlignment: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/GuardClause:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Style/MultilineMethodCallIndentation:
-  EnforcedStyle: indented_relative_to_receiver
-
-Style/NegatedIf:
-  Enabled: false
-
-Style/SpaceInLambdaLiteral:
-  EnforcedStyle: require_space
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: false
-
-Style/TrailingCommaInLiteral:
-  EnforcedStyleForMultiline: comma

data/README.md

@@ -8,39 +8,84 @@ Gut job or not, FixerUpper makes that file into the result of your dreams,
 backsplash, shiplap, and all.
 
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+FixerUpper is a wrapper around Tilt template engines.
+
+It requires explicit registration of template engines:
 
 ```ruby
-gem "fixer_upper"
+fixer_upper = FixerUpper.new
+fixer_upper.register_tilt("erb", engine: Tilt::ERBTemplate)
+
+renderer =
+  fixer_upper.renderer(
+    filename: "file.erb",
+    content: %(<%= 1 + 1 %>),
+    engines: %i[erb]
+  )
+renderer.call # => "2"
 ```
 
-And then execute:
-
-    $ bundle
+It allows for setting "global" options.
 
+```ruby
+fixer_upper = FixerUpper.new
+fixer_upper.register_tilt(
+  "csv",
+  engine: Tilt::CSVTemplate,
+  options: { col_sep: "|" }
+)
+
+template = %(csv << ["hello", "world"])
+
+renderer =
+  fixer_upper.renderer(
+    filename: "file.csv",
+    content: template,
+    engines: %i[csv]
+  )
+renderer.call # => "hello|world\n"
+```
 
-## Usage
+It works with non-tilt templates as well
 
 ```ruby
-require "commonmarker"
+class Upcase
+  def initialize(_filename, memo)
+    @memo = memo
+  end
 
-class FixerUpperCmark
-  def call(text, parse_option: :DEFAULT)
-    CommonMarker.render_html(text, parse_option)
+  def render(_view_scope, &block)
+    @memo.upcase
   end
 end
 
 fixer_upper = FixerUpper.new
-fixer_upper.register("md", "markdown", to: FixerUpperCmark.new, \
-  parse_option: :HARDBREAKS)
+fixer_upper.register("upcase", engine: Upcase)
+
+renderer =
+  fixer_upper.renderer(
+    filename: "file.upcase",
+    content: "hi",
+    engines: %i[upcase]
+  )
+renderer.call # => "HI"
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
 
-fixer_upper.renovate("file.md")
-# OR
-fixer_upper.diy("**text**", "md")
+```ruby
+gem "fixer_upper"
 ```
 
+And then execute:
+
+    $ bundle
+
 
 ## Development
 

data/fixer_upper.gemspec

@@ -23,10 +23,13 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.1.0"
 
+  spec.add_runtime_dependency "tilt", "~> 2.0"
+
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "sass"
+  spec.add_development_dependency "the_bath_of_zahn"
 end

data/lib/fixer_upper.rb

@@ -1,63 +1,24 @@
-require "fixer_upper/contractor"
+require "forwardable"
+
+require "tilt"
+
 require "fixer_upper/error"
-require "fixer_upper/renovation"
+require "fixer_upper/engine_registry"
+require "fixer_upper/renderer"
+require "fixer_upper/tilt_template_bridge"
 require "fixer_upper/version"
 
 class FixerUpper
-  def initialize
-    @engine_registry = {}
-    @options_registry = {}
-    @renovation = Renovation.new(@engine_registry, @options_registry)
-  end
-
-  def register(*keys, to:, **options)
-    keys.each do |key|
-      @engine_registry[key] = to
-      @options_registry[key] = options
-    end
-  end
+  extend Forwardable
 
-  def for(key)
-    @engine_registry[key]
-  end
-
-  def renovate(filepath, contents = nil, **options, &block)
-    @renovation.renovate(
-      filepath: filepath,
-      text: contents,
-      options: options,
-      block: block,
-      bang: false
-    )
-  end
+  def_delegator :@engine_registry, :register
+  def_delegator :@engine_registry, :register_tilt
 
-  def renovate!(filepath, contents = nil, **options, &block)
-    @renovation.renovate(
-      filepath: filepath,
-      text: contents,
-      options: options,
-      block: block,
-      bang: true
-    )
-  end
-
-  def diy(text, *engines, **options, &block)
-    @renovation.diy(
-      text: text,
-      engines: engines,
-      options: options,
-      block: block,
-      bang: false
-    )
+  def initialize
+    @engine_registry = EngineRegistry.new
   end
 
-  def diy!(text, *engines, **options, &block)
-    @renovation.diy(
-      text: text,
-      engines: engines,
-      options: options,
-      block: block,
-      bang: true
-    )
+  def renderer(**args)
+    Renderer.new(engine_registry: @engine_registry, **args)
   end
 end

data/lib/fixer_upper/engine_registry.rb

@@ -0,0 +1,70 @@
+class FixerUpper
+  class EngineRegistry
+    def initialize
+      @engines = {}
+    end
+
+    def register(*names, engine:, options: {})
+      if definitely_like_tilt_template?(engine)
+        register_tilt(*names, engine: engine, options: options)
+      else
+        register_fixer_upper(names, engine, options)
+      end
+    end
+
+    def register_tilt(*names, engine:, options: {})
+      engine_bridge =
+        TiltTemplateClassBridge.new(engine, options)
+
+      names.each do |name|
+        register_single(name, engine_bridge)
+      end
+    end
+
+    def engine?(engine)
+      @engines.key?(engine.to_s)
+    end
+
+    def [](engine_name)
+      @engines[engine_name.to_s]
+    end
+
+    private
+
+    def definitely_like_tilt_template?(engine)
+      engine < Tilt::Template
+    end
+
+    def engine_class_name(engine)
+      if engine.is_a?(TiltTemplateClassBridge)
+        engine.tilt_engine_class.name
+      else
+        engine.name
+      end
+    end
+
+    def register_fixer_upper(names, engine, options)
+      if options.any?
+        raise Error::EngineDoesntAcceptOptions, \
+          "Only Tilt templates can accept options"
+      end
+
+      names.each do |name|
+        register_single(name, engine)
+      end
+    end
+
+    def register_single(name, engine)
+      if engine?(name)
+        existing_engine = self[name]
+
+        raise Error::MultipleEnginesForOneName, \
+          "Trying to register `#{engine_class_name(engine)}` " \
+          "to the name `#{name}`, " \
+          "but `#{engine_class_name(existing_engine)}` is already registered."
+      end
+
+      @engines[name.to_s] = engine
+    end
+  end
+end

data/lib/fixer_upper/error.rb

@@ -1,6 +1,9 @@
 class FixerUpper
   class Error < StandardError
-    class EngineNotFound < FixerUpper::Error
+    class MultipleEnginesForOneName < Error
+    end
+
+    class EngineDoesntAcceptOptions < Error
     end
   end
 end

data/lib/fixer_upper/renderer.rb

@@ -0,0 +1,45 @@
+class FixerUpper
+  class Renderer
+    attr_reader :engines
+
+    def initialize(engine_registry:,
+      filename:,
+      content:,
+      engines:,
+      view_scope: nil,
+      block: nil)
+      @engine_registry = engine_registry
+
+      @filename = filename
+      @content = content
+      @engines = engines || []
+      @view_scope = view_scope
+      @block = block
+    end
+
+    def call
+      @engines.reduce(@content) do |memo, engine|
+        if @engine_registry.engine?(engine)
+          render_engine(engine, memo)
+        else
+          memo
+        end
+      end
+    end
+
+    private
+
+    def render_engine(engine, memo)
+      fixer_upper_engine_class = @engine_registry[engine]
+
+      fixer_upper_engine = fixer_upper_engine_class.new(@filename, memo)
+
+      fixer_upper_engine.render(@view_scope, &@block)
+    end
+
+    def compute_extensions
+      basename = File.basename(@filename)
+      basename.split(".")[1..-1]
+    end
+  end
+end

data/lib/fixer_upper/tilt_template_bridge.rb

@@ -0,0 +1,26 @@
+class FixerUpper
+  class TiltTemplateClassBridge
+    attr_reader :tilt_engine_class
+
+    def initialize(engine, options)
+      @tilt_engine_class = engine
+      @options = options
+    end
+
+    def new(filename, content)
+      tilt_engine = @tilt_engine_class.new(filename, 1, @options) { content }
+
+      TiltTemplateInstanceBridge.new(tilt_engine)
+    end
+  end
+
+  class TiltTemplateInstanceBridge
+    def initialize(tilt_engine)
+      @tilt_engine = tilt_engine
+    end
+
+    def render(view_scope, &block)
+      @tilt_engine.render(view_scope, {}, &block)
+    end
+  end
+end

data/lib/fixer_upper/version.rb

@@ -1,3 +1,3 @@
 class FixerUpper
-  VERSION = "0.4.0".freeze
+  VERSION = "0.5.0".freeze
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fixer_upper
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Zach Ahn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-27 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: the_bath_of_zahn
+  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: Simple interface for template engines
 email:
 - engineering@zachahn.com
@@ -114,12 +142,10 @@ files:
 - bin/setup
 - fixer_upper.gemspec
 - lib/fixer_upper.rb
-- lib/fixer_upper/contractor.rb
-- lib/fixer_upper/engine/erb.rb
-- lib/fixer_upper/engine/noop.rb
-- lib/fixer_upper/engine/scss.rb
+- lib/fixer_upper/engine_registry.rb
 - lib/fixer_upper/error.rb
-- lib/fixer_upper/renovation.rb
+- lib/fixer_upper/renderer.rb
+- lib/fixer_upper/tilt_template_bridge.rb
 - lib/fixer_upper/version.rb
 homepage: 
 licenses:

data/lib/fixer_upper/contractor.rb

@@ -1,77 +0,0 @@
-class FixerUpper
-  class Contractor
-    def initialize(registry, options)
-      @registry = registry
-      @options = options
-    end
-
-    def call(text:, engines:, options:, filepath:, block:, bang:)
-      engines.reduce(text) do |memo, engine_name|
-        engine = find_engine(engine_name, bang)
-
-        if engine.nil?
-          next memo
-        end
-
-        parameters = parameters_for(engine)
-        merged_options =
-          options_for_engine(engine_name, options, parameters, filepath)
-
-        engine_invoke(engine, memo, merged_options, parameters, block)
-      end
-    end
-
-    private
-
-    def find_engine(engine_name, bang)
-      if bang
-        engine_or_raise(engine_name)
-      else
-        engine_or_nil(engine_name)
-      end
-    end
-
-    def engine_invoke(engine, text, options, parameters, block)
-      if options.any? && parameters.count >= 2
-        engine.call(text, **options, &block)
-      else
-        engine.call(text, &block)
-      end
-    end
-
-    def parameters_for(engine)
-      if engine.respond_to?(:parameters)
-        engine.parameters
-      else
-        engine.method(:call).parameters
-      end
-    end
-
-    def options_for_engine(engine_name, local_options, parameters, filepath)
-      default_options = @options[engine_name] || {}
-      specific_options = local_options[engine_name.to_sym] || {}
-
-      merged_options = default_options.merge(specific_options)
-
-      if parameters.include?([:keyreq, :filepath])
-        merged_options[:filepath] = filepath
-      end
-
-      merged_options
-    end
-
-    def engine_or_nil(engine_name)
-      @registry[engine_name]
-    end
-
-    def engine_or_raise(engine_name)
-      found_engine = @registry[engine_name]
-
-      if found_engine
-        found_engine
-      else
-        raise Error::EngineNotFound, "unknown engine: `#{engine_name}`"
-      end
-    end
-  end
-end

data/lib/fixer_upper/engine/erb.rb

@@ -1,13 +0,0 @@
-class FixerUpper
-  module Engine
-    class Erb
-      def call(text, scope:, filepath:, &block)
-        scope_binding = scope.instance_eval { binding }
-
-        erb = ::ERB.new(text)
-        erb.filename = filepath
-        erb.result(scope_binding)
-      end
-    end
-  end
-end

data/lib/fixer_upper/engine/noop.rb

@@ -1,9 +0,0 @@
-class FixerUpper
-  module Engine
-    class Noop
-      def call(text)
-        text
-      end
-    end
-  end
-end

data/lib/fixer_upper/engine/scss.rb

@@ -1,12 +0,0 @@
-class FixerUpper
-  module Engine
-    class Scss
-      def call(text, filepath:, **options)
-        options = options.merge(syntax: :scss, filename: filepath)
-
-        engine = ::Sass::Engine.new(text, **options)
-        engine.render
-      end
-    end
-  end
-end

data/lib/fixer_upper/renovation.rb

@@ -1,50 +0,0 @@
-class FixerUpper
-  class Renovation
-    def initialize(registry, options)
-      @registry = registry
-      @options = options
-    end
-
-    def renovate(filepath:, text: nil, options:, block: nil, bang:)
-      contents = file_contents(filepath, text)
-
-      diy(
-        text: contents,
-        engines: extensions(filepath).reverse,
-        options: options,
-        filepath: filepath,
-        block: block,
-        bang: bang
-      )
-    end
-
-    def diy(text:, engines:, options:, filepath: nil, block: nil, bang:)
-      contractor = Contractor.new(@registry, @options)
-      contractor.call(
-        text: text,
-        engines: engines,
-        options: options,
-        filepath: filepath,
-        block: block,
-        bang: bang
-      )
-    end
-
-    private
-
-    def file_contents(filepath, contents)
-      if contents
-        contents
-      else
-        File.read(filepath)
-      end
-    end
-
-    def extensions(filepath)
-      filename = File.basename(filepath)
-      divided_by_dots = filename.split(".")
-
-      divided_by_dots[1..-1]
-    end
-  end
-end