stupider_formatter 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3aa339e868dec2d179d8bdcfff89d657ae427c6f9ed43ea3638bcc9a6cb34e8
+  data.tar.gz: 2397a49f2d19e667df4f4ff624a5371627406b3174a276499547449b92f28487
+SHA512:
+  metadata.gz: 719b38d16b0c5ece526e405beef0d64a22890684d7bdef39d3a6153fe116d9e4a1563c907a4a14595ad8388bd44f6347ae4aeebace94837ec93781db237a4743
+  data.tar.gz: e351317d869247b6df50ca5f8826b3e60ed8ddd2a86b99c7ee48ef9da5776a68d5f4196e3916536dd3c3bf6e998aff27fbafc4c307113106f87cb9b0229bfdb7

data/.bundle/config

@@ -0,0 +1,3 @@
+---
+BUNDLE_PATH: "vendor"
+BUNDLE_BIN: "bin"

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Christoph Olszowka
+
+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.rdoc

@@ -0,0 +1,129 @@
+= StupiderFormatter
+
+This is a fork from https://github.com/colszowka/stupid_formatter
+
+= StupidFormatter
+
+StupidFormatter let's you pipe text through processors in a chain by abstracting the actual implementation
+details of each processor into a unified API. By default, it can do ERb, Markdown (via RDiscount) and
+syntax-highlight with CodeRay.
+
+Say you want to format some markdown-formatted text with RDiscount and also include some ERb processing
+with CodeRay syntax highlighting, you could configure the chain somewhere at the beginning of your app like so:
+
+  StupidFormatter.chain = [StupidFormatter::Erb, StupidFormatter::RDiscount]
+  
+Then, pass in your Markdown-marked-up, ERb-riddled string to <code>StupidFormatter.result</code> or
+just call <code>string.formatted</code> and you'll see results. 
+
+The ERb, RDiscount chain mentioned above is actually the default, so if you want to stick with that,
+just skip that chain config step (yes, it is a stupid example).
+
+Formatters are processed in the order they are given in the Array, so ERb comes first, then RDiscount
+in this example.
+
+To install, do:
+
+  sudo gem install stupid_formatter
+  
+This is so completely alpha, you have no idea! Don't expect beautiful code or RDoc.
+
+== Using the formatters directly
+
+Of course, you can access the formatters directly as well. To format a string with RDiscount, do:
+  
+  StupidFormatter::RDiscount.new("# some markdown").result
+  
+== Custom formatters
+
+You can define your own formatters very easily by conforming to the public API, which is:
+
+* inherit from StupidFormatter::AbstractFormatter
+* make a result instance method that does not take any arguments
+* use the local attribute 'input' to do whatever you want with the text, and return it
+
+=== Example custom formatter
+
+In our example, let's create a formatter that will reverse the text.
+
+  class StupidFormatter::WrittenInReverse < StupidFormatter::AbstractFormatter
+    def result
+      input.reverse
+    end
+  end
+  
+After adding that to the chain with
+
+  StupidFormatter.chain << StupidFormatter::WrittenInReverse
+  
+Your text will be reversed when calling <code>"some string".formatted</code>
+
+== ERb Helpers
+
+=== Capturing blocks with ERb
+
+The ERb-formatter offers a capture-helper, which allows you to capture the content of a block into
+a variable like so:
+
+  <% @foo = capture do %>
+    Bar
+  <% end %>
+  Foo<%= @foo %>
+  
+The above example will render into "FooBar". This functionality is used in the Coderay helper, which
+is automatically included in the ERb formatter, see next section.
+
+=== Syntax highlighting with Coderay
+
+With the CoderayHelper that gets included into the ERb formatter automatically, you can get syntax-highlighting
+very easily:
+  
+  <% highlight do %>
+    puts 'Your Awesome Ruby(tm) here!'
+  <% end %>
+  
+The language defaults to :ruby, but you can pass in any CodeRay-language to the highlight method:
+
+  <% highlight :javascript do %>
+    var foo = 'bar';
+  <% end %>
+  
+The highlighting is configured to use CSS instead of in-place colors, so you might want to add a 
+decent (http://railscasts.com/stylesheets/coderay.css) coderay css file into your HTML.
+
+Thanks Ryan for making that great CodeRay CSS and giving it away (http://railscasts.com/episodes/46-catch-all-route)!
+  
+=== Making your own helpers
+
+Let's make a helper that reverses the text you gave in the block, like so:
+
+  <% written_in_reverse do %>
+    anna
+  <% end %>
+  
+Just create a module that uses the capture helper and appends the result to the @output_buffer and include it
+in the ERb helper, like so:
+
+  module WrittenInReverse
+    def written_in_reverse
+      text = capture { yield }
+      @output_buffer << text.reverse
+    end
+  end
+  StupidFormatter::ERb.send :include, WrittenInReverse
+
+This will print 'anna' in your ERb. Easy, right?
+  
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Christoph Olszowka. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "stupider_formatter"
+    gem.summary = %Q{A stupid formatter for piping text through markup processors}
+    gem.description = %Q{A stupid formatter for piping text through markup processors with a unified API}
+    gem.email = "hi at l33t dot name"
+    gem.homepage = "https://github.com/fliiiix/stupider_formatter"
+    gem.authors = ["Christoph Olszowka", "l33tname"]
+    gem.add_dependency "rdiscount", ">= 1.5.0"
+    gem.add_dependency "coderay", ">= 0.9.0"
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "stupider_formatter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/stupid_formatter.rb

@@ -0,0 +1,100 @@
+require 'rdiscount'
+require 'erb'
+require 'coderay'
+
+class String
+  #
+  # Pipes this string through the StupidFormatter and it's configured chain.
+  # The same as StupidFormatter.result(some_string)
+  #
+  def formatted
+    StupidFormatter.result(self)
+  end
+end
+
+module StupidFormatter
+  class << self
+    #
+    # Returns the current processing chain. Defaults to [StupidFormatter::Erb, StupidFormatter::RDiscount]
+    #
+    def chain
+      @chain ||= [StupidFormatter::Erb, StupidFormatter::RDiscount]
+    end
+
+    #
+    # Make the formatter chain configurable. Pass in an Array of Formatters in the order
+    # you want them processed in.
+    #
+    def chain=(chain)
+      @chain = chain
+    end
+
+    #
+    # Will put the input string through all formatters in the chain
+    #
+    def result(input)
+      output = input.clone
+      chain.each do |formatter|
+        output = formatter.new(output).result
+      end
+      output
+    end
+  end
+
+  #
+  # Base class for formatters, providing the basic API.
+  #
+  class AbstractFormatter
+    attr_reader :input
+
+    def initialize(input)
+      @input = input.to_s.strip
+      raise "Please use this only in subclasses" if self.class == AbstractFormatter
+    end
+
+    def result
+      raise "This should be implemented by subclasses"
+    end
+  end
+
+  class Erb < AbstractFormatter
+    def result(alternative_binding=nil)
+      if RUBY_VERSION >= '2.6'
+        ERB.new(input, trim_mode: "%<>", eoutvar: "@output_buffer").result(alternative_binding || binding)
+      else
+        ERB.new(input, 0, "%<>", "@output_buffer").result(alternative_binding || binding)
+      end
+    end
+
+    # Helper for capturing output in a erb block for later use, i.e.
+    #   <% @my_var = capture do %>
+    #     Bar
+    #   <% end %>
+    #   Foo<%= @my_var %>
+    # will render FooBar.
+    #
+    def capture
+      old_buffer, @output_buffer = @output_buffer, ''
+      yield
+      @output_buffer
+    ensure
+      @output_buffer = old_buffer
+    end
+  end
+
+  class RDiscount < AbstractFormatter
+    def result
+      Markdown.new(input).to_html
+    end
+  end
+
+  module CoderayHelper
+    def highlight(language=:ruby)
+      code = capture { yield }
+      @output_buffer << CodeRay.scan(code, language).div(:css => :class)
+    end
+  end
+end
+
+# Add coderay helper by default
+StupidFormatter::Erb.send :include, StupidFormatter::CoderayHelper

data/stupider_formatter.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: stupider_formatter 0.3.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "stupider_formatter".freeze
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Christoph Olszowka".freeze, "l33tname".freeze]
+  s.date = "2021-11-20"
+  s.description = "A stupid formatter for piping text through markup processors with a unified API".freeze
+  s.email = "hi at l33t dot name".freeze
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".bundle/config",
+    ".document",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/stupid_formatter.rb",
+    "stupider_formatter.gemspec",
+    "test/fixtures/erb_coderay_markdown_example.txt",
+    "test/fixtures/erb_coderay_markdown_expectation.txt",
+    "test/helper.rb",
+    "test/test_erb_formatter.rb",
+    "test/test_rdiscount_formatter.rb",
+    "test/test_stupid_formatter.rb"
+  ]
+  s.homepage = "https://github.com/fliiiix/stupider_formatter".freeze
+  s.rubygems_version = "3.2.3".freeze
+  s.summary = "A stupid formatter for piping text through markup processors".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+  end
+
+  if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<rdiscount>.freeze, [">= 1.5.0"])
+    s.add_runtime_dependency(%q<coderay>.freeze, [">= 0.9.0"])
+    s.add_development_dependency(%q<shoulda>.freeze, [">= 0"])
+  else
+    s.add_dependency(%q<rdiscount>.freeze, [">= 1.5.0"])
+    s.add_dependency(%q<coderay>.freeze, [">= 0.9.0"])
+    s.add_dependency(%q<shoulda>.freeze, [">= 0"])
+  end
+end
+

data/test/fixtures/erb_coderay_markdown_example.txt

@@ -0,0 +1,11 @@
+# A heading
+
+<p>A basic paragraph</p>
+
+<% if 1 == 2 %>
+  Some plain ERB conditional
+<% end %>
+
+<% highlight do %>
+  puts "foo bar baz"
+<% end %>

data/test/fixtures/erb_coderay_markdown_expectation.txt

@@ -0,0 +1,12 @@
+<h1>A heading</h1>
+
+<p>A basic paragraph</p>
+
+
+
+
+<div class="CodeRay">
+  <div class="code"><pre>  puts <span class="string"><span class="delimiter">&quot;</span><span class="content">foo bar baz</span><span class="delimiter">&quot;</span></span>
+</pre></div>
+</div>
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'stupid_formatter'
+
+class Test::Unit::TestCase
+  #
+  # Loads fixture files into a string
+  #
+  def fixtures(filename)
+    @fixtures ||= {} # Initialize cache if not present
+    return @fixtures[filename.to_sym] if @fixtures[filename.to_sym] # Return if cached
+    @fixtures[filename.to_sym] = File.read( File.join(File.dirname(__FILE__), 'fixtures', "#{filename}.txt") )
+  end
+end

data/test/test_erb_formatter.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+class TestErbFormatter < Test::Unit::TestCase
+  context "A chunk of erb-formatted text" do
+    setup do
+      @text = "<%= 'foo bar baz' %>"
+    end
+
+    context "after piping it through a new erb formatter instance" do
+      setup do
+        @result = StupidFormatter::Erb.new(@text).result
+      end
+
+      should("render 'foo bar baz'") { assert_equal 'foo bar baz', @result.strip.chomp }
+    end
+  end
+
+  context "A chunk of erb-formatted text that includes a block using the highlight-syntax" do
+    setup do
+      @text = '<% highlight do %>
+puts "foo bar baz"
+<% end %>'
+    end
+
+    context "after piping it through a new erb instance" do
+      setup do
+        @result = StupidFormatter::Erb.new(@text).result
+      end
+
+      should('match <div class="CodeRay">') { assert_match(/\<div class="CodeRay"\>/, @result.strip.chomp) }
+    end
+  end
+end

data/test/test_rdiscount_formatter.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+class TestRDiscountFormatter < Test::Unit::TestCase
+  context "With a chunk of markdown-formatted text" do
+    setup do
+      @text = "# some heading"
+    end
+    
+    context "after piping it through a new rdiscount formatter instance" do
+      setup do
+        @result = StupidFormatter::RDiscount.new(@text).result
+      end
+      
+      should("render '<h1>some heading</h1>'") { assert_equal '<h1>some heading</h1>', @result.strip.chomp }
+    end
+  end
+end

data/test/test_stupid_formatter.rb

@@ -0,0 +1,40 @@
+require 'helper'
+
+class TestStupidFormatter < Test::Unit::TestCase
+  context "After configuring the StupidFormatter.chain to [StupidFormatter::Erb, StupidFormatter::RDiscount]" do
+    setup do
+      StupidFormatter.chain = [StupidFormatter::Erb, StupidFormatter::RDiscount]
+    end
+    
+    should "return StupidFormatter::Erb for the first chain item" do
+      assert_equal StupidFormatter::Erb, StupidFormatter.chain[0]
+    end
+    
+    should "return StupidFormatter::RDiscount for the last chain item" do
+      assert_equal StupidFormatter::RDiscount, StupidFormatter.chain[-1]
+    end
+    
+    should("have 2 chain items") { assert_equal 2, StupidFormatter.chain.length }
+    
+    context "when I put a complex erb/coderay/markdown fixture through the formatter" do
+      setup do
+        @result = StupidFormatter.result(fixtures(:erb_coderay_markdown_example))
+      end
+      
+      should "render as in the expectation fixture" do
+        assert_equal fixtures(:erb_coderay_markdown_expectation), @result
+      end
+    end
+    
+    context "when I call formatted on a complex fixture string" do
+      setup do
+        @result = fixtures(:erb_coderay_markdown_example).formatted
+      end
+      
+      should "render as in the expectation fixture" do
+        assert_equal fixtures(:erb_coderay_markdown_expectation), @result
+      end
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: stupider_formatter
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Christoph Olszowka
+- l33tname
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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: A stupid formatter for piping text through markup processors with a unified
+  API
+email: hi at l33t dot name
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- ".bundle/config"
+- ".document"
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/stupid_formatter.rb
+- stupider_formatter.gemspec
+- test/fixtures/erb_coderay_markdown_example.txt
+- test/fixtures/erb_coderay_markdown_expectation.txt
+- test/helper.rb
+- test/test_erb_formatter.rb
+- test/test_rdiscount_formatter.rb
+- test/test_stupid_formatter.rb
+homepage: https://github.com/fliiiix/stupider_formatter
+licenses: []
+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: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: A stupid formatter for piping text through markup processors
+test_files: []