curly-templates 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 771f76ff2fc6fc4e3947ee8a205897a9930a02cc
-  data.tar.gz: 98c36121c84ad15081e32868ca1c8613365ea6ed
+  metadata.gz: 8dc47b05807f9a31c5c14d714c1f2edc3b0f8544
+  data.tar.gz: 79e7274d887bde4a5078e2573fa923682b58aa2b
 SHA512:
-  metadata.gz: 9893fb5b0c90b082c462128dd4bbd889d375f2913c703ae52b9d97cdb6dcf2de54f92e08032d8efd1007815a50672820bc5902a71fc5001723213719575bac29
-  data.tar.gz: 6ba0441db8486cdf248debd4e9d7f95d5ef8eafb2cbb53153684b5367679ada012206b289285a8c65eb94455c3a33b91209457814cf46829faf76f77f179bfc3
+  metadata.gz: 51eff4770731f8c3aadf3342595c0d8e513d0931790443bb0b8372376bf4893fc3c0ce82ad78542f1c70cc5aba151b696d7c7fda61c5e3e2f76b2b2c0ca41c62
+  data.tar.gz: 67015325572d49db533fab92f11319670074531ef424bb5182124e3d0ce3f85413338b488b000673566e05e80aca15ec99ce7886f6e3c06145d731e82f1723cf

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+Gemfile.lock
+/bin

data/.rspec

@@ -0,0 +1 @@
+-r spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/.yardopts

@@ -0,0 +1,3 @@
+--plugin yard-tomdoc
+--markup-provider=redcarpet
+--markup=markdown

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 ### Unreleased
 
+### Curly 2.6.0 (July 4, 2016)
+
+* Add support for Rails 5.
+
+* Add support for arbitrary component attributes. If the presenter method accepts
+  arbitrary keyword arguments, the corresponding component is allowed to pass
+  any attribute it wants.
+
+  *Jeremy Rodi*
+
+* Add support for testing presenters with RSpec:
+
+  ```ruby\
+  require 'curly/rspec'
+
+  # spec/presenters/posts/show_presenter_spec.rb
+  describe Posts::ShowPresenter, type: :presenter do
+    describe "#body" do
+      it "renders the post's body as Markdown" do
+        assign(:post, double(:post, body: "**hello!**"))
+        expect(presenter.body).to eq "<strong>hello!</strong>"
+      end
+    end
+  end
+  ```
+  
+  *Daniel Schierbeck*
+
 ### Curly 2.5.0 (May 19, 2015)
 
 * Allow passing a block as the `default:` option to `presents`.

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org/'
+source 'https://rubygems.org'
 
 gemspec
 
@@ -7,8 +7,10 @@ platform :ruby do
   gem 'yard-tomdoc'
   gem 'redcarpet'
   gem 'github-markup'
-  gem 'rails', '~> 4.2.0', require: false
+  gem 'rails', '~> 5.0.0', require: false
   gem 'rspec-rails', require: false
   gem 'benchmark-ips', require: false
   gem 'stackprof', require: false
 end
+
+gem 'genspec', github: "bquorning/genspec", ref: "rails-5-support"

data/README.md

@@ -21,7 +21,8 @@ to a presenter class.
 3. [Presenters](#presenters)
     1. [Layouts and content blocks](#layouts-and-content-blocks)
     2. [Rails helper methods](#rails-helper-methods)
-    3. [Examples](#examples)
+    3. [Testing](#testing)
+    4. [Examples](#examples)
 4. [Caching](#caching)
 
 
@@ -151,7 +152,28 @@ All argument values will be strings. A compilation error will be raised if
 - a required keyword argument in the method definition is not set as an attribute in the
   component.
 
-You can define default values using Ruby's own syntax.
+You can define default values using Ruby's own syntax. Additionally, if the presenter
+method accepts arbitrary keyword arguments using the `**doublesplat` syntax then all
+attributes will be valid for the component, e.g.
+
+```ruby
+def greetings(**names)
+  names.map {|name, greeting| "#{name}: #{greeting}!" }.join("\n")
+end
+```
+
+```html
+{{greetings alice=hello bob=hi}}
+<!-- The above would be rendered as: -->
+alice: hello!
+bob: hi!
+```
+
+Note that since keyword arguments in Ruby are represented as Symbol objects, which are
+not garbage collected in Ruby versions less than 2.2, accepting arbitrary attributes
+represents a security vulnerability if your application allows untrusted Curly templates
+to be rendered. Only use this feature with trusted templates if you're not on Ruby 2.2
+yet.
 
 
 ### Conditional blocks
@@ -512,6 +534,57 @@ end
 ```
 
 
+### Testing
+
+Presenters can be tested directly, but sometimes it makes sense to integrate with
+Rails on some levels. Currently, only RSpec is directly supported, but you can
+easily instantiate a presenter:
+
+```ruby
+SomePresenter.new(context, assigns)
+```
+
+`context` is a view context, i.e. an object that responds to `render`, has all
+the helper methods you expect, etc. You can pass in a test double and see what
+you need to stub out. `assigns` is the hash containing the controller and local
+assigns. You need to pass in a key for each argument the presenter expects.
+
+#### Testing with RSpec
+
+In order to test presenters with RSpec, make sure you have `rspec-rails` in your
+Gemfile. Given the following presenter:
+
+```ruby
+# app/presenters/posts/show_presenter.rb
+class Posts::ShowPresenter < Curly::Presenter
+  presents :post
+  
+  def body
+    Markdown.render(@post.body)
+  end
+end
+```
+
+You can test the presenter methods like this:
+
+```ruby
+# You can put this in your `spec_helper.rb`.
+require 'curly/rspec'
+
+# spec/presenters/posts/show_presenter_spec.rb
+describe Posts::ShowPresenter, type: :presenter do
+  describe "#body" do
+    it "renders the post's body as Markdown" do
+      assign(:post, double(:post, body: "**hello!**"))
+      expect(presenter.body).to eq "<strong>hello!</strong>"
+    end
+  end
+end
+```
+
+Note that your spec *must* be tagged with `type: :presenter`.
+
+
 ### Examples
 
 Here is a simple Curly template – it will be looked up by Rails automatically.
@@ -698,7 +771,7 @@ Thanks to [Zendesk](http://zendesk.com/) for sponsoring the work on Curly.
 
 - Daniel Schierbeck ([@dasch](https://github.com/dasch))
 - Benjamin Quorning ([@bquorning](https://github.com/bquorning))
-- Jeremy Rodi ([@redjazz96](https://github.com/redjazz96))
+- Jeremy Rodi ([@medcat](https://github.com/medcat))
 - Alisson Cavalcante Agiani ([@thelinuxlich](https://github.com/thelinuxlich))
 - Łukasz Niemier ([@hauleth](https://github.com/hauleth))
 - Cristian Planas ([@Gawyn](https://github.com/Gawyn))

data/Rakefile

@@ -1,119 +1,6 @@
-require 'rubygems'
-require 'bundler'
-require 'rake'
-require 'date'
-
-Bundler.setup
-
-#############################################################################
-#
-# Helper functions
-#
-#############################################################################
-
-def name
-  "curly"
-end
-
-def gem_name
-  "#{name}-templates"
-end
-
-def version
-  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
-  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
-end
-
-def date
-  Date.today.to_s
-end
-
-def gemspec_file
-  "#{gem_name}.gemspec"
-end
-
-def gem_file
-  "#{gem_name}-#{version}.gem"
-end
-
-def replace_header(head, header_name, value = nil)
-  value ||= send(header_name)
-  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{value}'"}
-end
-
-#############################################################################
-#
-# Standard tasks
-#
-#############################################################################
-
-task :default => :spec
-
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-desc "Open an irb session preloaded with this library"
-task :console do
-  sh "irb -rubygems -r ./lib/#{name}.rb"
-end
-
-#############################################################################
-#
-# Packaging tasks
-#
-#############################################################################
-
-desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
-task :release => :build do
-  unless `git branch` =~ /^\* master$/
-    puts "You must be on the master branch to release!"
-    exit!
-  end
-  sh "git commit --allow-empty -a -m 'Release #{version}'"
-  sh "git tag v#{version}"
-  sh "git push origin master"
-  sh "git push origin v#{version}"
-  sh "gem push pkg/#{gem_name}-#{version}.gem"
-end
-
-desc "Build #{gem_file} into the pkg directory"
-task :build => :gemspec do
-  sh "mkdir -p pkg"
-  sh "gem build #{gemspec_file}"
-  sh "mv #{gem_file} pkg"
-end
 
-desc "Generate #{gemspec_file}"
-task :gemspec => :validate do
-  # read spec file and split out manifest section
-  spec = File.read(gemspec_file)
-  head, manifest, tail = spec.split("  # = MANIFEST =\n")
-
-  # replace name version and date
-  replace_header(head, :name, gem_name)
-  replace_header(head, :version)
-  replace_header(head, :date)
-
-  # determine file list from git ls-files
-  files = `git ls-files`.
-    split("\n").
-    sort.
-    reject { |file| file =~ /^\./ }.
-    reject { |file| file =~ /^(rdoc|pkg)/ }.
-    map { |file| "    #{file}" }.
-    join("\n")
-
-  # piece file back together and write
-  manifest = "  s.files = %w[\n#{files}\n  ]\n"
-  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
-  File.open(gemspec_file, 'w') { |io| io.write(spec) }
-  puts "Updated #{gemspec_file}"
-end
+RSpec::Core::RakeTask.new(:spec)
 
-desc "Validate #{gemspec_file}"
-task :validate do
-  unless Dir['VERSION*'].empty?
-    puts "A `VERSION` file at root level violates Gem best practices."
-    exit!
-  end
-end
+task :default => :spec

data/circle.yml

@@ -1,6 +1,6 @@
 machine:
   ruby:
-    version: 2.1.5
+    version: 2.2.3
 dependencies:
   post:
     - bundle install

data/curly-templates.gemspec

@@ -1,10 +1,12 @@
+require './lib/curly/version'
+
 Gem::Specification.new do |s|
   s.specification_version = 2 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.rubygems_version = '1.3.5'
 
   s.name              = 'curly-templates'
-  s.version           = '2.5.0'
+  s.version           = Curly::VERSION
   s.date              = '2015-05-19'
 
   s.summary     = "Free your views!"
@@ -19,92 +21,13 @@ Gem::Specification.new do |s|
 
   s.rdoc_options = ["--charset=UTF-8"]
 
-  s.add_dependency("actionpack", [">= 3.1", "< 5.0"])
+  s.add_dependency("actionpack", [">= 3.1", "< 5.1"])
 
-  s.add_development_dependency("railties", [">= 3.1", "< 5.0"])
+  s.add_development_dependency("railties", [">= 3.1", "< 5.1"])
   s.add_development_dependency("rake")
   s.add_development_dependency("rspec", "~> 2.12")
   s.add_development_dependency("genspec")
 
-  # = MANIFEST =
-  s.files = %w[
-    CHANGELOG.md
-    CONTRIBUTING.md
-    Gemfile
-    README.md
-    Rakefile
-    circle.yml
-    curly-templates.gemspec
-    lib/curly-templates.rb
-    lib/curly.rb
-    lib/curly/attribute_scanner.rb
-    lib/curly/compiler.rb
-    lib/curly/component_compiler.rb
-    lib/curly/component_scanner.rb
-    lib/curly/dependency_tracker.rb
-    lib/curly/error.rb
-    lib/curly/incomplete_block_error.rb
-    lib/curly/incorrect_ending_error.rb
-    lib/curly/invalid_component.rb
-    lib/curly/parser.rb
-    lib/curly/presenter.rb
-    lib/curly/presenter_not_found.rb
-    lib/curly/railtie.rb
-    lib/curly/scanner.rb
-    lib/curly/syntax_error.rb
-    lib/curly/template_handler.rb
-    lib/generators/curly/controller/controller_generator.rb
-    lib/generators/curly/controller/templates/presenter.rb.erb
-    lib/generators/curly/controller/templates/view.html.curly.erb
-    lib/rails/projections.json
-    perf/compile_benchmark.rb
-    perf/compile_profile.rb
-    perf/component_benchmark.rb
-    spec/attribute_scanner_spec.rb
-    spec/collection_blocks_spec.rb
-    spec/compiler/collections_spec.rb
-    spec/compiler/context_blocks_spec.rb
-    spec/compiler_spec.rb
-    spec/component_compiler_spec.rb
-    spec/component_scanner_spec.rb
-    spec/components_spec.rb
-    spec/conditional_blocks_spec.rb
-    spec/dummy/.gitignore
-    spec/dummy/app/controllers/application_controller.rb
-    spec/dummy/app/controllers/dashboards_controller.rb
-    spec/dummy/app/helpers/application_helper.rb
-    spec/dummy/app/presenters/dashboards/collection_presenter.rb
-    spec/dummy/app/presenters/dashboards/item_presenter.rb
-    spec/dummy/app/presenters/dashboards/new_presenter.rb
-    spec/dummy/app/presenters/dashboards/partials_presenter.rb
-    spec/dummy/app/presenters/dashboards/show_presenter.rb
-    spec/dummy/app/presenters/layouts/application_presenter.rb
-    spec/dummy/app/views/dashboards/_item.html.curly
-    spec/dummy/app/views/dashboards/collection.html.curly
-    spec/dummy/app/views/dashboards/new.html.curly
-    spec/dummy/app/views/dashboards/partials.html.curly
-    spec/dummy/app/views/dashboards/show.html.curly
-    spec/dummy/app/views/layouts/application.html.curly
-    spec/dummy/config.ru
-    spec/dummy/config/application.rb
-    spec/dummy/config/boot.rb
-    spec/dummy/config/environment.rb
-    spec/dummy/config/environments/test.rb
-    spec/dummy/config/routes.rb
-    spec/generators/controller_generator_spec.rb
-    spec/integration/application_layout_spec.rb
-    spec/integration/collection_blocks_spec.rb
-    spec/integration/context_blocks_spec.rb
-    spec/integration/partials_spec.rb
-    spec/matchers/have_structure.rb
-    spec/parser_spec.rb
-    spec/presenter_spec.rb
-    spec/scanner_spec.rb
-    spec/spec_helper.rb
-    spec/syntax_error_spec.rb
-    spec/template_handler_spec.rb
-  ]
-  # = MANIFEST =
-
+  s.files      = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(perf|spec)/}) }
   s.test_files = s.files.select { |path| path =~ /^spec\/.*_spec\.rb/ }
 end