RubyGems - markababy - Versions diffs - 1.0.0 → 1.3.2 - Mend

markababy 1.0.0 → 1.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

checksums.yaml +7 -0
data/LICENSE.txt +4 -0
data/README.md +64 -0
data/lib/markababy.rb +10 -49
data/lib/markababy/builder.rb +59 -0
data/lib/markababy/{rails.rb → rails_template_context.rb} +1 -19
data/lib/markababy/rails_template_handler.rb +10 -0
data/lib/markababy/railtie.rb +9 -0
data/markababy.gemspec +10 -5
metadata +24 -45
data/README.txt +0 -29
data/Rakefile +0 -5
data/spec/markababy_rails_spec.rb +0 -28
data/spec/markababy_spec.rb +0 -73
data/spec/views/index.html.rb +0 -7

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b6a178f6e549aad27f67e34231d7846cbc671071070c7b1c0278f6d68ae2f4b
+  data.tar.gz: 6c0168a1e33b4a38f9d8836996cb9a30f50a193e3faf6d73257dc1e6605702a6
+SHA512:
+  metadata.gz: 992a470b24c2761a51027872afb0523968f3ec464bb0e13ef54c77402a974a14d17d9ba98ac8c9ed2145c111f8dc5ec4ef6f32b84674bd0fc50bded13def160e
+  data.tar.gz: 462b050b3c49ae95525b9d927e30bb1226d2902b244ae4dd646c1d6e0dde68eea40ac2579d959aa54e887f2253583508b446da0c40f9d56ce8e708b44a4226d5

data/LICENSE.txt ADDED

@@ -0,0 +1,4 @@
+Copyright (c) 2011-2021 TIMCRAFT
+This is an Open Source project licensed under the terms of the LGPLv3 license.
+Please see <http://www.gnu.org/licenses/lgpl-3.0.html> for license text.

data/README.md ADDED

@@ -0,0 +1,64 @@
+# markababy
+[![Gem Version](https://badge.fury.io/rb/markababy.svg)](https://badge.fury.io/rb/markababy) [![Build Status](https://api.travis-ci.org/timcraft/markababy.svg?branch=master)](https://travis-ci.org/timcraft/markababy)
+Markaby's little sister. A small library for writing HTML in Ruby.
+## Installation
+    $ gem install markababy
+## Example
+Usage is similar to [Markaby](http://en.wikipedia.org/wiki/Markaby),
+and easy to use directly from a Ruby script:
+```ruby
+require 'markababy'
+Markababy.markup do
+  html do
+    head { title 'Boats.com' }
+    body do
+      h1 'Boats.com has great deals'
+      ul do
+        li '$49 for a canoe'
+        li '$39 for a raft'
+        li '$29 for a huge boot that floats and can fit 5 people'
+      end
+    end
+  end
+end
+```
+Use `Markababy.capture` if you want to capture
+the output as a string instead of printing it to STDOUT.
+## Rails template usage
+Add markababy as a dependency to your Gemfile; do the bundle dance; then change
+the extension on your template files from .erb to .rb and you can start writing
+your templates in Ruby!
+Controller instance variables and helpers will be available as methods.
+## Less is more
+Some differences from Markaby:
+* No auto-stringification
+* No element classes or IDs
+* No validation
+* No XHTML
+## Alternatives
+* https://github.com/timcraft/hom
+* https://github.com/judofyr/tubby
+* https://github.com/digital-fabric/rubyoshka

data/lib/markababy.rb CHANGED

@@ -1,8 +1,9 @@
+require 'markababy/builder'
 require 'cgi'
 module Markababy
   def self.capture(options = {}, &block)
-    [].tap { |output| markup(options.merge(output: output), &block) }.join
+    [].tap { |output| markup(options.merge(:output => output), &block) }.join
   end
   def self.markup(options = {}, &block)
@@ -10,58 +11,18 @@ module Markababy
     options[:output] = $stdout unless options.has_key?(:output)
-    options[:output] << "<!DOCTYPE html>\n" if options[:doctype]
+    options[:output] << doctype if options[:doctype]
     Builder.new(options, &block)
   end
-  class Builder < BasicObject
-    def initialize(options, &block)
-      @options = options
-      @output = @options[:output]
-      @escape = @options[:escape]
-      @context = @options[:context]
-      instance_eval(&block)
-    end
-    def method_missing(sym, *args, &block)
-      if !@context.nil? && @context.respond_to?(sym)
-        return @context.send(sym, *args, &block)
-      end
-      attributes, content = [], []
-      args.flatten.each do |arg|
-        if arg.respond_to?(:to_hash)
-          arg.to_hash.each { |k, v| attributes << ' %s="%s"' % [@escape[k.to_s], @escape[v.to_s]] }
-        elsif arg.respond_to?(:id2name)
-          attributes << ' %s' % @escape[arg.to_s]
-        elsif arg.respond_to?(:html_safe?) && arg.html_safe?
-          content << arg.to_s
-        else
-          content << @escape[arg.to_s]
-        end
-      end
-      @output << (attributes.empty? ? "<#{sym}>" : "<#{sym}#{attributes.join}>")
-      @output << content.join unless content.empty?
-      instance_eval(&block) unless block.nil?
-      @output << "</#{sym}>" unless content.empty? && block.nil?
-    end
+  def self.doctype
+    @doctype ||= "<!DOCTYPE html>\n".freeze
+  end
-    def text(content)
-      if content.respond_to?(:html_safe?) && content.html_safe?
-        @output << content.to_s
-      else
-        @output << @escape[content.to_s]
-      end
-    end
+  if defined?(Rails)
+    require 'markababy/rails_template_context'
+    require 'markababy/rails_template_handler'
+    require 'markababy/railtie'
   end
 end

data/lib/markababy/builder.rb ADDED

@@ -0,0 +1,59 @@
+module Markababy
+  class Builder < BasicObject
+    def initialize(options, &block)
+      @options = options
+      @output = @options[:output]
+      @escape = @options[:escape]
+      @context = @options[:context]
+      instance_eval(&block)
+    end
+    def context_responds_to?(name)
+      @context.respond_to?(name)
+    end
+    def method_missing(sym, *args, &block)
+      if @context && context_responds_to?(sym)
+        return @context.send(sym, *args, &block)
+      end
+      attributes, content = [], []
+      args.flatten.each do |arg|
+        if arg.respond_to?(:to_hash)
+          arg.to_hash.each { |k, v| attributes << ' %s="%s"' % [@escape[k.to_s], @escape[v.to_s]] }
+        elsif arg.respond_to?(:id2name)
+          attributes << ' %s' % @escape[arg.to_s]
+        elsif arg.respond_to?(:html_safe?) && arg.html_safe?
+          content << arg.to_s
+        else
+          content << @escape[arg.to_s]
+        end
+      end
+      @output << (attributes.empty? ? "<#{sym}>" : "<#{sym}#{attributes.join}>")
+      @output << content.join unless content.empty?
+      instance_eval(&block) unless block.nil?
+      @output << "</#{sym}>" unless content.empty? && block.nil?
+    end
+    def text(content)
+      if content.respond_to?(:html_safe?) && content.html_safe?
+        @output << content.to_s
+      else
+        @output << @escape[content.to_s]
+      end
+    end
+    def self.const_missing(name)
+      ::Object.const_get(name)
+    end
+  end
+end

data/lib/markababy/{rails.rb → rails_template_context.rb} RENAMED

@@ -1,12 +1,9 @@
-require 'markababy'
-require 'action_view'
 module Markababy
   class RailsTemplateContext
     def initialize(controller)
       @controller = controller
-      @ivars = @controller.instance_variables - @controller.class.new.instance_variables
+      @ivars = @controller.instance_variables.map(&:to_sym)
     end
     def respond_to_missing?(sym, include_private = false)
@@ -23,19 +20,4 @@ module Markababy
       end
     end
   end
-  module RailsTemplateHandler
-    def self.call(template)
-      "self.output_buffer = ''\n" +
-      "Markababy.capture(output: self.output_buffer, context: Markababy::RailsTemplateContext.new(self)) do\n" +
-      "#{template.source}\n" +
-      "end\n"
-    end
-    def self.extended(base)
-      base.register_default_template_handler :rb, self
-    end
-  end
-  ActionView::Template.extend RailsTemplateHandler
 end

data/lib/markababy/rails_template_handler.rb ADDED

@@ -0,0 +1,10 @@
+module Markababy
+  module RailsTemplateHandler
+    def self.call(template, source)
+      "self.output_buffer = ''\n" +
+      "Markababy.capture(:output => self.output_buffer, :context => Markababy::RailsTemplateContext.new(self)) do\n" +
+      "#{template.source}\n" +
+      "end\n"
+    end
+  end
+end

data/lib/markababy/railtie.rb ADDED

@@ -0,0 +1,9 @@
+module Markababy
+  class Railtie < Rails::Railtie
+    initializer 'markababy.action_view' do |app|
+      ActiveSupport.on_load(:action_view) do
+        ActionView::Template.register_default_template_handler :rb, RailsTemplateHandler
+      end
+    end
+  end
+end

data/markababy.gemspec CHANGED

@@ -1,14 +1,19 @@
 Gem::Specification.new do |s|
   s.name = 'markababy'
-  s.version = '1.0.0'
+  s.version = '1.3.2'
+  s.license = 'LGPL-3.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
-  s.homepage = 'http://github.com/timcraft/markababy'
+  s.homepage = 'https://github.com/timcraft/markababy'
   s.description = 'Markaby\'s little sister'
   s.summary = 'See description'
-  s.files = Dir.glob('{lib,spec}/**/*') + %w(README.txt Rakefile markababy.gemspec)
-  s.add_development_dependency('activesupport', ['>= 3.0.3'])
-  s.add_development_dependency('actionpack', ['>= 3.0.3'])
+  s.files = Dir.glob('lib/**/*.rb') + %w(LICENSE.txt README.md markababy.gemspec)
+  s.required_ruby_version = '>= 1.9.3'
   s.require_path = 'lib'
+  s.metadata = {
+    'homepage' => 'https://github.com/timcraft/markababy',
+    'source_code_uri' => 'https://github.com/timcraft/markababy',
+    'bug_tracker_uri' => 'https://github.com/timcraft/markababy/issues'
+  }
 end

metadata CHANGED

@@ -1,38 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: markababy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease:
+  version: 1.3.2
 platform: ruby
 authors:
 - Tim Craft
-autorequire:
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-10-11 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &10149360 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.3
-  type: :development
-  prerelease: false
-  version_requirements: *10149360
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  requirement: &10149030 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.3
-  type: :development
-  prerelease: false
-  version_requirements: *10149030
+date: 2021-01-04 00:00:00.000000000 Z
+dependencies: []
 description: Markaby's little sister
 email:
 - mail@timcraft.com
@@ -40,36 +17,38 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/markababy/rails.rb
+- LICENSE.txt
+- README.md
 - lib/markababy.rb
-- spec/markababy_rails_spec.rb
-- spec/markababy_spec.rb
-- spec/views/index.html.rb
-- README.txt
-- Rakefile
+- lib/markababy/builder.rb
+- lib/markababy/rails_template_context.rb
+- lib/markababy/rails_template_handler.rb
+- lib/markababy/railtie.rb
 - markababy.gemspec
-homepage: http://github.com/timcraft/markababy
-licenses: []
-post_install_message:
+homepage: https://github.com/timcraft/markababy
+licenses:
+- LGPL-3.0
+metadata:
+  homepage: https://github.com/timcraft/markababy
+  source_code_uri: https://github.com/timcraft/markababy
+  bug_tracker_uri: https://github.com/timcraft/markababy/issues
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 1.8.10
-signing_key:
-specification_version: 3
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
 summary: See description
 test_files: []

data/README.txt DELETED

@@ -1,29 +0,0 @@
-Markaby's little sister.
-Usage is similar to Markaby, and easy to use directly from a Ruby script:
-  require 'markababy'
-  Markababy.markup do
-    html do
-      head { title 'Boats.com' }
-      body do
-        h1 'Boats.com has great deals'
-        ul do
-          li '$49 for a canoe'
-          li '$39 for a raft'
-          li '$29 for a huge boot that floats and can fit 5 people'
-        end
-      end
-    end
-  end
-Use Markababy.capture if you want to capture the output as a string instead
-of printing it to $stdout.
-Some differences from Markaby:
-* No auto-stringification
-* No element classes or IDs
-* No validation
-* No XHTML

data/Rakefile DELETED

@@ -1,5 +0,0 @@
-require 'rake/testtask'
-Rake::TestTask.new do |t|
-  t.test_files = FileList['spec/*_spec.rb']
-end

data/spec/markababy_rails_spec.rb DELETED

@@ -1,28 +0,0 @@
-require 'minitest/autorun'
-require 'abstract_controller'
-require 'markababy'
-require 'markababy/rails'
-class DummyController < AbstractController::Base
-  # cf. http://amberbit.com/blog/render-views-partials-outside-controllers-rails-3
-  include AbstractController::Rendering
-  include AbstractController::Layouts
-  include AbstractController::Helpers
-  self.view_paths = 'spec/views'
-  def index
-    @message = 'Controller says hello!'
-    render template: 'index'
-  end
-end
-describe DummyController do
-  it 'should return the correct markup' do
-    output = '<html><head><title>Controller says hello!</title><p>12,345,678</p></head></html>'
-    DummyController.new.index.must_equal output
-  end
-end

data/spec/markababy_spec.rb DELETED

@@ -1,73 +0,0 @@
-require 'minitest/autorun'
-require 'markababy'
-require 'active_support/core_ext/string/output_safety'
-class ExampleContext
-  def baconize(word)
-    "#{word} bacon!"
-  end
-end
-describe Markababy do
-  it 'should render tags without attributes or content correctly' do
-    Markababy.capture { br }.must_equal '<br>'
-  end
-  it 'should render tags with content correctly' do
-    Markababy.capture { title 'Untitled' }.must_equal '<title>Untitled</title>'
-  end
-  it 'should escape content correctly' do
-    Markababy.capture { h1 'Apples & Oranges' }.must_equal '<h1>Apples &amp; Oranges</h1>'
-  end
-  it 'should render tags with an attribute hash correctly' do
-    Markababy.capture { input type: :text, size: 40 }.must_equal '<input type="text" size="40">'
-  end
-  it 'should render tags with an attribute array correctly' do
-    Markababy.capture { input [{type: :text}, :disabled] }.must_equal '<input type="text" disabled>'
-  end
-  it 'should render tags with attributes and content correctly' do
-    Markababy.capture { div 'O hai', class: 'name' }.must_equal '<div class="name">O hai</div>'
-  end
-  it 'should render nested tags correctly' do
-    Markababy.capture { h1 { span 'Chunky bacon!' } }.must_equal '<h1><span>Chunky bacon!</span></h1>'
-  end
-  it 'should allow output target to be specified' do
-    output = []
-    Markababy.markup(output: output) { hr }
-    output.join.must_equal '<hr>'
-  end
-  it 'should allow context for method lookup to be specified' do
-    output = Markababy.capture(context: ExampleContext.new) { h1 baconize('Super chunky') }
-    output.must_equal '<h1>Super chunky bacon!</h1>'
-  end
-  it 'should provide a method for rendering text content' do
-    output = Markababy.capture { h1 { text 'Hello '; strong 'World' } }
-    output.must_equal '<h1>Hello <strong>World</strong></h1>'
-  end
-  it 'should respect the html_safe? method' do
-    Markababy.capture { text 'Hello&nbsp;World'.html_safe }.must_equal 'Hello&nbsp;World'
-    output = Markababy.capture { h1 'Hello <strong>World</strong>'.html_safe }
-    output.must_equal '<h1>Hello <strong>World</strong></h1>'
-  end
-  it 'should provide an option for including a doctype declaration' do
-    output = Markababy.capture(doctype: true) { html { body { p 'INSERT CONTENT HERE' } } }
-    output.must_equal "<!DOCTYPE html>\n<html><body><p>INSERT CONTENT HERE</p></body></html>"
-  end
-end

data/spec/views/index.html.rb DELETED

@@ -1,7 +0,0 @@
-html {
-  head {
-    title message
-    p number_with_delimiter(12345678)
-  }
-}