bobkit 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95d438130c23ff3d67f82c43499807d9ff7981c1
-  data.tar.gz: 591174800ff603804a523ec3aba57eb8d5139254
+  metadata.gz: b0d5ce22323d9500b5f9550aaee8eefcdb139087
+  data.tar.gz: d7a7214c3385c6f8342b52b94dc4856a0590a117
 SHA512:
-  metadata.gz: 3eac42431d113cbdab201ac2c9072564b4a234341385b957249726996084f653e44e0ee083f8c3cfdb6319a87683cf78f6b02f21bad92ebc631df17b7d2955ad
-  data.tar.gz: e19de9084da62e9b20da94b35d1221f08bf567d50ebbb5fb67d3282cab3472fd561ecdfc4bc7da5be2658e071c509974077d616b98b908f5c98f781478fa6f19
+  metadata.gz: 9d8f76201dd38ae07037e1834f55598a508cd5d1263465a1a428699c4eaa421c462b6b05177e7edc002273406f402a213cad43330c82625b218c39bc2aee3d01
+  data.tar.gz: 7f464bc9ed9f2780113a54b633327f65ccb7d6714ee49a53481611c981323e8c8a71d8fa46038c0e36531e91a87f82af18347cd661536b352b8f99054c0cff1f

data/README.md

@@ -8,19 +8,23 @@ Bobkit - Site Generation Toolkit
 
 ---
 
-Bobkit is a lightweight tookit for generating static websites with Slim, SCSS
-and CoffeeScript.
+Bobkit is a lightweight toolkit for generating static websites with:
 
-The design intentions were:
+#### `Slim + SCSS + CoffeeScript + Markdown + I18n`
 
-- To provide easy to use wrapper methods for Slim, SCSS and CoffeeScript
-- To not impose any directory structure (this is not a blog generator...).
-- To allow you to use standard ruby for generating your site.
-- To be packaged as a library, and not a command line tool.
-- To provide sensible default locations that are easily overridable.
-- To add `render` and `layout` support to Slim (Rails-like).
-- To add i18n support to Slim (Rails-like).
-- To add `@import 'globbing/*'` support to SCSS (Rails-like).
+---
+
+The design intentions were to:
+
+- Provide easy to use wrapper methods for Slim, SCSS, CoffeeScript and 
+  Markdown.
+- Not impose any directory structure (this is not another blog generator...).
+- Allow you to use standard ruby for generating your site how you see fit.
+- Be packaged as a library, and not a command line tool.
+- Provide sensible default locations that are easily overridable.
+- Add `render` and `layout` support to Slim (Rails-like).
+- Add i18n support to Slim (Rails-like).
+- Add `@import 'globbing/*'` support to SCSS (Rails-like).
 
 ---
 
@@ -87,6 +91,9 @@ templates_folder 'views'
 # Default: "#{templates_folder}/layouts"
 layouts_folder 'my_layouts'
 
+# Location of markdown files. Default: "markdown"
+markdown_folder 'docs'
+
 # Location of the source SCSS files. Default: "styles"
 styles_folder 'styles'
 
@@ -115,7 +122,6 @@ scss_options cache: true, syntax: :scss, style: :nested
 use_defaults
 ```
 
-
 ### Slim 
 
 ```ruby
@@ -135,11 +141,16 @@ html = render 'user', layout: 'default', email: 'bob@kit.com'
 
 # You can save to a file in the `output_folder`
 render 'user', layout: 'default', email: 'bob@kit.com', output: 'bob'
+
+# You can send an HTML string as the content of a layout
+render content: "<h1>Hello</h1>", layout: 'default'
 ```
 
 In addition, you can call `= render 'template'` from inside a slim 
-template.
+template. 
 
+To check if a certain context variable was provided to a slim template,
+you can use `if have? :varname`.
 
 ### SCSS
 
@@ -161,11 +172,23 @@ js = compile_js 'script'
 compile_js 'script', output: 'main'
 ```
 
+### Markdown
+
+```ruby
+# Compile a markdown file to HTML string
+html = markdown 'article'
+
+# Compile directly to a file, inside a slim layout
+markdown 'article', layout: :default, output: 'article'
+
+# All options pass through directly to the slim renderer
+html = markdown 'article', layout: :default, sidebar: true
+```
 
 ### Asset helpers
 
 Anything other than CSS, Javascript and HTML is considered an asset.
-These are some helpers to help you move them acount from input to output
+These are some helpers to help you move them around from input to output
 folders.
 
 ```ruby
@@ -208,7 +231,6 @@ create_folder 'my_folder'
 create_folder_for 'some/folder/with/file.png'
 ```
 
-
 ### File Watcher
 
 Bobkit comes bundled with FileWatcher, and has a shortcut method to 
@@ -238,8 +260,6 @@ Todo
 - [ ] Consider adding `input_root` which will prefix all others
 - [ ] YAML loader (data_folder?)
 - [ ] CSV Loader (data_folder?)
-- [ ] Maybe: Render from/to Markdown
-- [ ] Maybe: Render to JSON
 
 
 [1]: https://github.com/DannyBen/bobkit/tree/master/examples

data/lib/bobkit.rb

@@ -5,6 +5,7 @@ require 'sass-globbing'
 require 'slim'
 require 'coffee_script'
 require 'filewatcher'
+require 'rdiscount'
 
 require 'bobkit/options_base'
 require 'bobkit/location_options'
@@ -17,6 +18,7 @@ require 'bobkit/sass_bridge'
 require 'bobkit/slim_options'
 require 'bobkit/slim_bridge'
 require 'bobkit/coffee_bridge'
+require 'bobkit/markdown_bridge'
 require 'bobkit/assets'
 require 'bobkit/watcher'
 

data/lib/bobkit/location_options.rb

@@ -6,6 +6,10 @@ module Bobkit
       setopt :templates_folder, path, 'templates'
     end
 
+    def markdown_folder(path=nil)
+      setopt :markdown_folder, path, 'markdown'
+    end
+
     def layouts_folder(path=nil)
       setopt :layouts_folder, path, "#{templates_folder}/layouts"
     end

data/lib/bobkit/markdown_bridge.rb

@@ -0,0 +1,32 @@
+module Bobkit
+  module MarkdownBridge
+    def markdown(file, *args)
+      MarkdownHandler.instance.compile file, *args
+    end
+
+    class MarkdownHandler
+      include Singleton
+      include SlimBridge
+      include LocationOptions
+
+      def compile(file, options={})
+        markdown = RDiscount.new file_content file
+        content = markdown.to_html
+        options[:content] = content
+        content = render options if options[:layout]
+        content
+      end
+
+      private
+
+      def file_content(basename)
+        File.read markdown_file basename
+      end
+
+      def markdown_file(basename)
+        "#{markdown_folder}/#{basename}.md"
+      end
+    end
+
+  end
+end

data/lib/bobkit/scope.rb

@@ -26,5 +26,7 @@ module Bobkit
         super
       end
     end
+    alias_method :have?, :respond_to?
+
   end
 end

data/lib/bobkit/slim_bridge.rb

@@ -17,13 +17,14 @@ module Bobkit
         partial = options.delete :partial
         layout  = options.delete :layout
         output  = options.delete :output
-        
+        content = options.delete :content
+
         context = options.empty? ? scope : options
         if context.is_a? Hash or !context
           context = Scope.new context 
         end
 
-        content = Slim::Template.new(partial_filename(partial), slim_options).render(context)
+        content ||= Slim::Template.new(partial_filename(partial), slim_options).render(context)
         content = Slim::Template.new(layout_filename(layout), slim_options).render(context) { content } if layout
         create_file "#{output_folder}/#{output}.html", content if output
         content

data/lib/bobkit/tasks.rb

@@ -6,6 +6,7 @@ module Bobkit
     include SlimBridge
     include CoffeeBridge
     include I18nBridge
+    include MarkdownBridge
     include SlimOptions
     include SassOptions
     include ScopeOptions

data/lib/bobkit/version.rb

@@ -1,3 +1,3 @@
 module Bobkit
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bobkit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-02 00:00:00.000000000 Z
+date: 2016-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slim
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: runfile
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +206,7 @@ files:
 - lib/bobkit/i18n_bridge.rb
 - lib/bobkit/i18n_mixin.rb
 - lib/bobkit/location_options.rb
+- lib/bobkit/markdown_bridge.rb
 - lib/bobkit/options_base.rb
 - lib/bobkit/sass_bridge.rb
 - lib/bobkit/sass_options.rb