middleman-decorators 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e7282cea37d32aa9a1b058338494eff35348777
+  data.tar.gz: 7d18b45886a53bcfef004c261a2af01477e35c6c
+SHA512:
+  metadata.gz: 8e061c318e38de21178e5694a7d4a1d683cd147cc82d1b8d8ff2c55373963dfd82adb9d059380f89a710e1968995447949c9afbebfb4492712bf7922cf0c18af
+  data.tar.gz: 989156aa64d663496d770ee60d3efad193663b9c406302e148757e9d97e9d5f529cc66827acfe9fe097088a8fb54ead97d8d1856a932a1e58f2ff527305292b0

data/.gitignore

@@ -0,0 +1,3 @@
+tmp
+Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--color --format 'documentation'

data/.rubocop.yml

@@ -0,0 +1,56 @@
+AllCops:
+  TargetRubyVersion: 2.0
+  DisplayCopNames: true
+  DefaultFormatter: simple
+  Include:
+    - Rakefile
+  Exclude:
+    - spec/spec_helper.rb
+
+# Style
+Style/FileName:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/IndentationConsistency:
+  EnforcedStyle: rails
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: aligned
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: aligned
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+
+# can't enforce style to require
+# the trailing underscore -- so disabling for now
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+# Metrics
+Metrics/LineLength:
+  Max: 90
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/AbcSize:
+  Max: 20
+
+# Performance
+Performance/RedundantBlockCall:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+middleman-decorators

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+sudo: false
+cache: bundler
+bundler_args: "--without development"
+rvm:
+  - 2.3.1
+  - 2.2
+  - 2.1
+  - 2.0

data/Gemfile

@@ -0,0 +1,18 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "middleman"
+
+if RUBY_VERSION >= "2.0.0"
+  gem "pry-byebug"
+else
+  gem "pry-debugger"
+end
+
+gem "rake",     "~> 10"
+gem "aruba",    "~> 0.7.4", require: false
+gem "rspec",    "~> 3.4",   require: false
+gem "cucumber", "~> 2.0",   require: false
+gem "capybara", "~> 2.5"
+gem "rubocop",  "~> 0.42"

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 Jordan Andree
+
+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,56 @@
+# Middleman Decorators
+[![Build Status](https://travis-ci.org/jordanandree/middleman-decorators.png?branch=master)](https://travis-ci.org/jordanandree/middleman-decorators)
+[![Dependency Status](https://gemnasium.com/badges/github.com/jordanandree/ebookie.svg)](https://gemnasium.com/github.com/jordanandree/ebookie)
+
+Use Decorators (AKA Presenters) in Middleman.
+**This project is not yet stable so use with caution.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'middleman-decorators', '~> 1.0'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+## Usage
+
+Activate the extension in `config.rb`:
+
+```ruby
+activate :decorators
+```
+
+By default, decorators are added to `$app_root/decorators`
+
+Example decorator:
+
+```ruby
+class WidgetDecorator < Middleman::Decorators::Base
+  def complex_method
+    [..]
+  end
+end
+```
+
+To use the decorator in a view:
+
+```ruby
+<% decorate(data.widgets, WidgetDecorator).complex_method %>
+```
+
+## Contributing
+
+If there is any thing you'd like to contribute or fix, please:
+
+- Fork the repo
+- Make your changes
+- Add specs for any new functionality
+- Verify all existing tests work properly
+- Make a pull request

data/Rakefile

@@ -0,0 +1,5 @@
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/middleman/decorators/base.rb

@@ -0,0 +1,17 @@
+module Middleman
+  module Decorators
+    class Base
+      attr_reader :context
+      alias h context
+
+      def initialize(attributes, context)
+        @attributes = attributes
+        @context    = context
+
+        @attributes.each do |key, val|
+          define_singleton_method(key) { val }
+        end
+      end
+    end
+  end
+end

data/lib/middleman/decorators/extension.rb

@@ -0,0 +1,25 @@
+module Middleman
+  module Decorators
+    class Extension < ::Middleman::Extension
+      option :decorators_path, "decorators", "Path to decorators relative to root"
+
+      def initialize(*args)
+        super
+        decorators_path = app.root_path.join(options.decorators_path, "*.rb")
+        Dir[decorators_path].each do |f|
+          require f
+        end
+      end
+
+      module Helpers
+        def decorate(object, class_name)
+          class_name.send(:new, object, self)
+        end
+      end
+
+      helpers Helpers
+    end
+
+    ::Middleman::Extensions.register(:decorators, Middleman::Decorators::Extension)
+  end
+end

data/lib/middleman/decorators/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Decorators
+    VERSION = "1.0.0".freeze
+  end
+end

data/lib/middleman/decorators.rb

@@ -0,0 +1,4 @@
+require "middleman-core"
+require "middleman/decorators/version" unless defined?(Middleman::Decorators::VERSION)
+require "middleman/decorators/extension"
+require "middleman/decorators/base"

data/lib/middleman-decorators.rb

@@ -0,0 +1 @@
+require "middleman/decorators"

data/middleman-decorators.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "middleman/decorators/version"
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-decorators"
+  s.version     = Middleman::Decorators::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jordan Andree"]
+  s.email       = ["jordanandree@gmail.com"]
+  s.homepage    = "https://github.com/jordanandree/middleman-decorators"
+  s.summary     = "Use Decorators (Presenters) in Middleman"
+  s.description = "Use Decorators (Presenters) in Middleman"
+  s.license     = "MIT"
+  s.files       = `git ls-files -z`.split("\0")
+  s.test_files  = `git ls-files -z -- {fixtures,features}/*`.split("\0")
+  s.require_paths = ["lib"]
+
+  s.add_dependency "middleman-core", ["~> 4.0"]
+end

data/spec/features/rendering_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe "rendering", type: :feature do
+  before do
+    Middleman::Fixture.init(:base)
+    Middleman::Fixture.browser(Middleman::Fixture.app)
+    visit "/"
+  end
+
+  it "renders formatted title" do
+    expect(page).to have_content "Bar"
+    expect(page).to have_content "Foo"
+  end
+end

data/spec/fixtures/base/config.rb

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

data/spec/fixtures/base/decorators/data_decorator.rb

@@ -0,0 +1,5 @@
+class DataDecorator < Middleman::Decorators::Base
+  def formatted_title
+    title.titleize
+  end
+end

data/spec/fixtures/base/source/index.html.erb

@@ -0,0 +1,9 @@
+---
+titles:
+  - title: bar
+  - title: foo
+---
+
+<% current_page.data.titles.map { |k| decorate(k, DataDecorator) }.each do |d| %>
+  <p><%= d.formatted_title %></p>
+<% end %>

data/spec/lib/middleman/decorators/extension_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe Middleman::Decorators::Extension do
+  let(:base_app) do
+    Middleman::Fixture.init :base
+    Middleman::Fixture.app
+  end
+
+  it "is should be registered" do
+    expect(Middleman::Extensions.registered[:decorators])
+      .to eq Middleman::Decorators::Extension
+  end
+end

data/spec/lib/middleman/decorators/version_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe Middleman::Decorators::VERSION do
+  it "is not empty" do
+    expect(subject >= "1.0.0").to be true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require "bundler/setup"
+Bundler.setup
+
+require "rspec"
+require "capybara/rspec"
+require "middleman-core"
+require "middleman-core/rack"
+
+Dir["./spec/support/*.rb"].each { |f| require f }
+
+if RUBY_VERSION >= "2.0.0"
+  require "pry-byebug"
+else
+  require "pry-debugger"
+end
+
+require "middleman/decorators"
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.profile_examples = 10
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+end

data/spec/support/fixture.rb

@@ -0,0 +1,43 @@
+require "fileutils"
+
+module Middleman
+  module Fixture
+    ROOT = File.expand_path("../..", __dir__).freeze
+    TMP  = File.join(ROOT, "tmp").freeze
+
+    class << self
+      def init(fixture)
+        cleanup!
+
+        `rsync -av ./spec/fixtures/#{fixture}/ #{TMP}/`
+        Dir.chdir TMP
+      end
+
+      def file(name, content)
+        file_path = File.join TMP, name
+        FileUtils.mkdir_p File.dirname(file_path)
+        File.open(file_path, "w") do |file|
+          file.write content
+        end
+      end
+
+      def cleanup!
+        Dir.chdir ROOT
+        FileUtils.rm_rf TMP
+      end
+
+      def app
+        ENV["MM_ROOT"] = TMP
+        ::Middleman::Application.new
+      end
+
+      def browser(middleman_app)
+        Capybara.app = ::Middleman::Rack.new(middleman_app).to_app do
+          set :root, Middleman::Fixture::TMP
+          set :environment, :development
+          set :show_exceptions, false
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: middleman-decorators
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jordan Andree
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-21 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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Use Decorators (Presenters) in Middleman
+email:
+- jordanandree@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/middleman-decorators.rb
+- lib/middleman/decorators.rb
+- lib/middleman/decorators/base.rb
+- lib/middleman/decorators/extension.rb
+- lib/middleman/decorators/version.rb
+- middleman-decorators.gemspec
+- spec/features/rendering_spec.rb
+- spec/fixtures/base/config.rb
+- spec/fixtures/base/decorators/data_decorator.rb
+- spec/fixtures/base/source/index.html.erb
+- spec/lib/middleman/decorators/extension_spec.rb
+- spec/lib/middleman/decorators/version_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixture.rb
+homepage: https://github.com/jordanandree/middleman-decorators
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Use Decorators (Presenters) in Middleman
+test_files: []