RubyGems - styledown - Versions diffs - 1.0.2.pre.0 → 2.0.0.pre.1 - Mend

styledown 1.0.2.pre.0 → 2.0.0.pre.1

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 (17) hide show

checksums.yaml +4 -4
data/.gitignore +1 -0
data/.travis.yml +1 -8
data/History.md +18 -6
data/Notes.md +2 -68
data/Rakefile +2 -7
data/Readme.md +21 -15
data/lib/styledown/version.rb +1 -1
data/lib/styledown.rb +11 -7
data/styledown.gemspec +3 -3
data/test/fixtures/simple/other_sample.md +3 -0
data/test/test.rb +38 -42
data/test/test_helper.rb +3 -3
data/vendor/dist/styledown.js +22576 -42343
metadata +18 -7
data/Gemfile.lock +0 -18
data/test/fixtures/simple/sample.css +0 -4

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4eec94b0a4e0d5a730357f9fdc5c82401656d74c
-  data.tar.gz: f55c31765bf24914dcdacb049de80394f5e058e8
+  metadata.gz: e42a396f82037aed88126bf20330f0bb452afdce
+  data.tar.gz: afe588018af86b3612eb3fef0ac60647281efcd9
 SHA512:
-  metadata.gz: d66440860aa56893f6d41faa897ae788b56d7ced326d3d8e29f4a5a115b8b65de31e6d6117b9d4272ef0927089711e385d8eeb7976cf4a84194ec504ca2f2e7e
-  data.tar.gz: 8d2363c1e1915e9927d7159fb1dc14fa0feb07c3efae32531ba9913c6ab20bfdbfb6305b42d1757a4435465b2ab456e176021765fc7cdb769a11cb8cc46ee82b
+  metadata.gz: fe33b286ca2127789c929b2ec4b6c1ebbe805d716ef8fc221ba384a2bef4a45285c49ed26b592cd899f5f947460a8e79bc4a8af4d75fa8d8b78df17a62ca9e17
+  data.tar.gz: 9d863cbaf3fc980ad3ee3fc6e2e69b4e065f95ec06d4844e4922d9fd3b58256108f907939045ab9f4bf93fb21fc5c966711695fdf646affb457edc9df3ecb7ad

data/.gitignore CHANGED Viewed

	@@ -1 +1,2 @@
1 1	*.gem
2	+ Gemfile.lock

data/.travis.yml CHANGED Viewed

@@ -1,11 +1,4 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 1.9.3
-notifications:
-  email:
-    recipients:
-     - dropbox+travis@ricostacruz.com
-    on_success: change
-    on_failure: change
+  - 2.3.0

data/History.md CHANGED Viewed

@@ -1,12 +1,24 @@
-## v1.0.2.pre.0 - January 16, 2014
+## [v2.0.0-pre1]
+> May  6, 2016
- * Update Styledown source to 1.0.2.
+- **Completely new API.** Update to use Styledown v2.0.0-pre1.
-## v1.0.1.pre.0 - September  5, 2014
+[v2.0.0-pre1]: https://github.com/styledown/styledown-rails/compare/v0.0.0...v2.0.0-pre1
- * Update Styledown source to 1.0.1.
- * Add support for `Styledown.parse(array of files)`.
+## [v1.0.1]
+> Apr 19, 2016
-## v0.7.0.pre.0 - September 1, 2014
+- Release as a non-prerelease-version. No functional changes.
+[v1.0.1]: https://github.com/styledown/styledown-rails/compare/v1.0.1.pre.0...v1.0.1
+## v1.0.1.pre.0
+> September  5, 2014
+- Update Styledown source to 1.0.1.
+- Add support for `Styledown.parse(array of files)`.
+## v0.7.0.pre.0
+> September 1, 2014
 Initial pre-release. No Rails integration, but plain Ruby integration works.

data/Notes.md CHANGED Viewed

@@ -3,11 +3,8 @@ Developer notes
 ### Updating source
-Use `rake update`.
-This will update `vendor/dist/styledown.js`. Get it as `dist/styledown.js` from
-the [styledown/styledown] repo. This is built using the `npm run prepublish`
-hook.
+Update `vendor/dist/styledown.js`. Get it as `dist/styledown.js` from the
+[styledown/styledown] repo. This is built using the `npm run prepublish` hook.
 [styledown/styledown]: https://github.com/styledown/styledown
@@ -17,66 +14,3 @@ hook.
     bump lib/styledown/version.rb
     gem build *.gemspec
     rake && gem push *.gem && git release v1.0.0
-Planned API
------------
-### Globbing
-Globbing should be supported to make things convenient.
-```rb
-Styledown.parse([
-  Rails.root.join('app/assets/stylesheets/*/*.less')
-])
-```
-### Controller integration
-There should be better Rails integration later on. It'd be nice to be able to
-simplify controller integration like so. (This should take caching into
-consideration)
-```rb
-module StyleguidesController
-  layout 'styleguide'
-  def show
-    render styleguide: CSS_PATHS
-  end
-  CSS_PATHS = [
-    'app/assets/stylesheets/components/*',
-    'app/assets/stylesheets/overrides/*',
-    'app/assets/stylesheets/foobar/*',
-  ]
-end
-```
-### Generator
-It'd be nice to do `rails g styledown:install` and have these things in place:
-```rb
-# config/routes.rb
-get '/styleguides' => 'styleguides#show'
-```
-```rb
-# app/controllers/styleguides_controller.rb
-module StyleguidesController
-  # ... see above
-end
-```
-```html
-<!-- app/views/layouts/styleguide.html.erb -->
-<html>
-<head>
-  <meta charset='utf-8'>
-</head>
-<body>
-  <%= yield %>
-</body>
-</html>
-```

data/Rakefile CHANGED Viewed

@@ -1,13 +1,8 @@
 require 'rake'
 require 'rake/testtask'
 Rake::TestTask.new do |t|
   t.test_files = Dir.glob('test/**/*test.rb')
 end
-task :default => :test
-desc "Updates styledown.js"
-task :update do
-  system "wget https://github.com/styledown/styledown/raw/master/dist/styledown.js -O vendor/dist/styledown.js"
-end
+task default: :test

data/Readme.md CHANGED Viewed

@@ -10,41 +10,47 @@ Ruby integration of [Styledown].
 ```rb
 # Gemfile
-gem 'styledown'
+gem 'styledown', '~> 2.0.0'
 ```
 [![Gem](https://img.shields.io/gem/v/styledown.svg?style=flat)](http://rubygems.org/gems/styledown "View this project in Rubygems")
 ## Plain Ruby integration
-API for `Styledown.parse` is exactly the same as the JS version ([docs]).
+These are provided:
+* `Styledown.parse`
+* `Styledown.parse_files`
+* `Styledown.render`
+API them is exactly the same as the JS version ([docs]).
 ```rb
 require 'styledown'
-# Passing a Styledown sting:
-Styledown.parse('### hello', bare: true)
 # Parsing files from disk:
-Styledown.parse([
-    '/path/to/input.css',
-    '/path/to/input.md',
-    '...'
+data = Styledown.parse_files([
+  '/path/to/buttons.md',
+  '/path/to/forms.md',
+  '...'
 ])
 # Parsing files from elsewhere:
-Styledown.parse([
-  { name: "input.md",  data: "### hi from md" },
-  { name: "input.css", data: "/**\n * hi from css:\n * world\n */" }
+data = Styledown.parse([
+  { name: 'buttons.md', contents: '### hi from buttons' },
+  { name: 'forms.md',   contents: '### hi from forms' },
 ])
+# Rendering a page:
+html = Styledown.render(data, 'buttons.md')
+html = Styledown.render(data, 'forms.md')
 ```
-[docs]: https://github.com/styledown/styledown/blob/master/docs/API.md#styledownparse
+[docs]: https://github.com/styledown/styledown/blob/v2/docs/api.md#styledownparse
 ## :copyright:
-**styledown** © 2014+, Rico Sta. Cruz. Released under the [MIT License].<br>
+**styledown** © 2014-2016, Rico Sta. Cruz. Released under the [MIT License].<br>
 Authored and maintained by Rico Sta. Cruz with help from [contributors].
 > [ricostacruz.com](http://ricostacruz.com) &nbsp;&middot;&nbsp;

data/lib/styledown/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module Styledown
   def self.version
-    version = "1.0.2-0"
+    '2.0.0-1'
   end
 end

data/lib/styledown.rb CHANGED Viewed

@@ -12,22 +12,26 @@ module Styledown
     end
   end
-  def parse(source, options={})
-    if array_of_filenames?(source)
-      source = unpack_files(source)
-    end
+  def parse(source, options = {})
     context.call('Styledown.parse', source, options)
   end
+  def parse_files(source, options = {})
+    parse unpack_files(source), options
+  end
+  def render(data, file, options = {})
+    context.call('Styledown.render', data, file, options)
+  end
   def js_version
     context.eval('Styledown.version')
   end
-private
+  private
   def unpack_files(source)
-    source.map { |file| { name: file, data: File.read(file) } }
+    source.map { |file| { name: file, contents: File.read(file) } }
   end
   def array_of_filenames?(source)

data/styledown.gemspec CHANGED Viewed

@@ -14,9 +14,9 @@ Gem::Specification.new do |s|
   s.author   = 'Rico Sta. Cruz'
   s.email    = 'hi@ricostacruz.com'
-  s.homepage = 'http://github.com/styledown/styledown-ruby'
+  s.homepage = 'http://github.com/styledown/styledown-rails'
   s.license  = 'MIT'
-  s.add_dependency 'execjs', '>= 0'
-  s.add_development_dependency 'rake', '>= 0'
+  s.add_dependency 'execjs', '>= 0', '< 3'
+  s.add_development_dependency 'rake', '>= 0', '< 12'
 end

data/test/fixtures/simple/other_sample.md ADDED Viewed

@@ -0,0 +1,3 @@
+### Sample md block
+Hello world.

data/test/test.rb CHANGED Viewed

@@ -1,69 +1,65 @@
 require File.expand_path('../test_helper', __FILE__)
-describe "Styledown.js_version" do
-  it "produces a string" do
+describe 'Styledown.js_version' do
+  it 'produces a string' do
     Styledown.js_version.must_match /^\d+\.\d+\.\d+/
   end
 end
-describe "Basic parsing" do
+describe 'Basic parsing' do
   before do
-    @output = Styledown.parse('### hi')
+    @data = Styledown.parse([{
+      name: 'buttons.md',
+      contents: '### hi'
+    }])
   end
-  it "produces an HTML fragment" do
-    @output.must_match /<h3[^>]+>hi<\/h3>/
+  it 'works' do
+    @data['files'].must_be_kind_of Hash
+    @data['files']['buttons.md'].must_be_kind_of Hash
+    @data['files']['buttons.md']['sections'].must_be_kind_of Hash
   end
-  it "doesn't produce an HTML document" do
-    @output.wont_match /^<!doctype html>/
-  end
-end
+  describe 'with rendering' do
+    before do
+      @output = Styledown.render(@data, 'buttons.md')
+    end
-describe "Working with many files" do
-  before do
-    @output = Styledown.parse([
-      { :name => "input.md",  :data => "### hi from md" },
-      { :name => "input.css", :data => "/**\n * hi from css:\n * world\n */" }
-    ])
-  end
+    it 'produces an HTML fragment' do
+      @output.must_match /<h3[^>]+>hi<\/h3>/
+    end
-  it "parses the Markdown file" do
-    @output.must_match /<h3[^>]+>hi from md<\/h3>/
+    it "doesn't produce an HTML document" do
+      @output.wont_match /^<!doctype html>/
+    end
   end
-  it "parses the CSS file" do
-    @output.must_match /<h3[^>]+>hi from css<\/h3>/
-  end
-end
+  describe 'with rendering with layouts' do
+    before do
+      @output = Styledown.render(@data, 'buttons.md', layout: '<!doctype html><%- body %>')
+    end
-describe 'head options' do
-  before do
-    @output = Styledown.parse('### hi', head: '<meta>')
-  end
-  it "includes the head text" do
-    @output.must_match /<meta>/
-  end
+    it 'produces HTML' do
+      @output.must_match /<h3[^>]+>hi<\/h3>/
+    end
-  it "produces an HTML document" do
-    @output.must_match /^<!doctype html>/
+    it "uses the layout" do
+      @output.must_match /^<!doctype html>/
+    end
   end
 end
 describe 'Working with arrays of strings' do
   before do
-    @output = Styledown.parse([
-      fixture_path('simple/sample.css'),
-      fixture_path('simple/sample.md')
+    @output = Styledown.parse_files([
+      fixture_path('simple/sample.md'),
+      fixture_path('simple/other_sample.md')
     ])
   end
-  it 'renders from .md' do
-    @output.must_match /Sample md block<\/h3>/
-  end
-  it 'renders from .css' do
-    @output.must_match /Sample CSS block<\/h3>/
+  it 'parses' do
+    @output['files'].must_be_kind_of Hash
+    @output['files'][fixture_path('simple/sample.md')].must_be_kind_of Hash
+    @output['files'][fixture_path('simple/other_sample.md')].must_be_kind_of Hash
   end
 end

data/test/test_helper.rb CHANGED Viewed

@@ -4,17 +4,17 @@ require './lib/styledown'
 begin
   require 'minitest/reporters'
   if ENV['reporter'] == 'spec'
-    Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new(:color => true)
+    Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new(color: true)
   else
     Minitest::Reporters.use! Minitest::Reporters::ProgressReporter.new
   end
 rescue LoadError => e
 end
-def test_path(path='')
+def test_path(path = '')
   File.expand_path("../#{path}", __FILE__)
 end
-def fixture_path(path='')
+def fixture_path(path = '')
   test_path "fixtures/#{path}"
 end