bobkit 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9039d57140e0dab71277e153eb1903e9a9eb3f2b
-  data.tar.gz: 2b43616ca5a43085b55191fa701063983d7becfe
+  metadata.gz: 7db6c694ea1adaf5fec4c8dab145d0204744aca3
+  data.tar.gz: 369d8e39afb9dea61523f7f8208283946d840b9f
 SHA512:
-  metadata.gz: e7e2b9b3f6823f05544a6dee29a64f5728c2bbfea54c432375679de276ce4c10abcf298b61b00c77eb5b0f251718f9eff6d65ba4ca513c32efe93280d9d82a8e
-  data.tar.gz: afd8794e232ecfa91b5a7d0b1e478c6654f673c4c7ffc7609b6a4bb5af26a03756369cb31f39f6968e1f6d71f52fd0e3b029b300a453b70a98114a3116862e56
+  metadata.gz: ed1294af999ff86255b1fd08091085478b19c3440955c706b220de5ed0dd86b029b3be09974cc9a36376a3691d5b8201fa2842600cc0a6214bc9134b1712a458
+  data.tar.gz: f88938070983f3e62cbf2705449a66de85b4d5512624851d93e1b76b03ee85728b79634e94d42930a6a44d6ff10a171c93db607062e182a51c065ec653641890

data/README.md

@@ -1,13 +1,203 @@
 Bobkit - Site Generation Toolkit
 ==================================================
 
+[![Gem](https://img.shields.io/gem/v/bobkit.svg?style=flat-square)](https://rubygems.org/gems/bobkit)
+[![Travis](https://img.shields.io/travis/DannyBen/bobkit.svg?style=flat-square)](https://travis-ci.org/DannyBen/bobkit)
+[![Code Climate](https://img.shields.io/codeclimate/github/DannyBen/bobkit.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/bobkit)
+[![Gemnasium](https://img.shields.io/gemnasium/DannyBen/bobkit.svg?style=flat-square)](https://gemnasium.com/DannyBen/bobkit)
+
+---
+
+Bobkit is a lightweight tookit for generating static websites with Slim, SCSS
+and CoffeeScript.
+
+The design intentions were:
+
+- 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 `@import 'globbing/*`` support to SCSS (Rails-like).
+
+---
+
+
+
+Install
+--------------------------------------------------
+
+`gem install bobkit`
+
+Or with Bundler:
+
+`gem 'bobkit'`
+
+
+
+Usage
+--------------------------------------------------
+
+The basic usage pattern is this:
+
+- Create a ruby file and include Bobkit
+- Create your input folders (for Slim templates, SCSS files etc.) 
+  wherever you want (or use the default locations, see below).
+- In your Ruby script, call Bobkit methods to generate your site.
+
+### Example
+
+```ruby
+require 'bobkit'
+include Bobkit::Actions
+
+# Convert Slim to HTML string
+html = render 'youtube', video: 'hi9tOILaiNs'
+puts html
+
+# Convert Slim to HTML file
+# This will use 'templates/youtube.slim', with the layout file
+# `templates/layouts/default.slim` and will generate 'output/bobcat.html'.
+render 'youtube', layout: 'default', video: 'hi9tOILaiNs', output: 'bobcat'
+
+# Compile SCSS
+# This will convert `styles/main.scss` to `output/css/style.css`
+compile_css 'main', output: 'style'
+```
+
+See more examples in the [Examples folder][1]
+
+
+Reference
+--------------------------------------------------
+
+### Setting folder locations and options
+
+Bobkit has defaults for everything, but you can easily change them.
+Each of these methods can be called with or without a parameter. When
+called without a parameter, it will simply return the value.
+
+```ruby
+# Location of source Slim templates. Default: "templates"
+templates_folder 'views'
+
+# Location of source Slim templates for layouts. 
+# Default: "#{templates_folder}/layouts"
+layouts_folder 'my_layouts'
+
+# Location of the source SCSS files. Default: "styles"
+styles_folder 'styles'
+
+# Output location. Default: "output"
+output_folder 'site'
+
+# Output location for CSS. Default: "#{output_folder}/css"
+css_output_folder "#{output_folder}/stylesheets"
+
+# Location of other source asset files (images etc.). Default: 'assets'
+assets_folder 'files'
+
+# Output location for assets. Default: "#{output_folder}/assets"
+assets_output_folder 'images'
+
+# Options for Slim generation.
+slim_options pretty: true, disable_escape: true
+
+# Options for SCSS generation.
+scss_options cache: true, syntax: :scss, style: :nested
+
+# Restore all settings to defaults
+use_defaults
+```
+
+
+### Slim 
+
+```ruby
+# You can set a scope before calling any `render`
+scope CatVideo.new
+html = render 'cats'
+
+# You can use a hash as scope
+scope email: 'bob@kit.com', name: 'Bob'
+html = render 'user'
+
+# You can send a scope directly to `render`
+html = render 'user', email: 'bob@kit.com', name: 'Bob'
+
+# You can render with a layout
+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'
+```
+
+
+### SCSS
+
+```ruby
+# You can compile SCSS to a CSS string, to do as you please with it
+css = compile_css 'style'
+
+# You can compile SCSS directly to a file
+compile_css 'style', output: 'main'
+```
+
+### CoffeeScript
+
+```ruby
+# You can compile CoffeeScript to a Javascript string
+js = compile_js 'script'
+
+# You can compile CoffeeScript directly to a file
+compile_js 'script', output: 'main'
+```
+
+
+### 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
+folders.
+
+```ruby
+# Copy a file from the `assets_folder` to the `assets_output_folder`
+copy_asset 'presskit.zip'
+
+# Copy a folder
+copy_asset 'images'
+```
+
+
+### Low level file and folder helpers
+
+If you want more control over what the `copy_asset` method provides, you
+can use any of these methods.
+
+```ruby
+# Copy a file - needed parent folders will be created as needed
+copy_file 'exact/path.zip', 'exact/output/file.zip'
+
+# Copy a folder - needed parent folders will be created as needed
+copy_file 'exact/path', 'exact/output/folder'
+
+# Create folder, and any of the needed parent folders
+create_folder 'my_folder'
+
+# Create folder for a file, with any of the needed parent folders
+create_folder_for 'some/folder/with/file.png'
+```
+
 
 Todo
 --------------------------------------------------
 
-[ ] Clean repo
-[ ] Publish gem
-[ ] Full test coverage
-[ ] copy_asset (file and folder)
-[ ] CoffeeScript
-[ ] Documentation
+- [ ] YAML loader (data_folder?)
+- [ ] CSV Loader (data_folder?)
+- [ ] Maybe: Include file watcher and auto generate
+- [ ] Maybe: Render from/to Markdown
+- [ ] Maybe: Render to JSON
+
+
+[1]: https://github.com/DannyBen/bobkit/tree/master/examples

data/lib/bobkit.rb

@@ -1,9 +1,16 @@
 require 'fileutils'
 require 'sass'
+require 'sass-globbing'
 require 'slim'
+require 'coffee_script'
 
+require 'bobkit/options_base'
+require 'bobkit/location_options'
 require 'bobkit/file_helpers'
-require 'bobkit/sass_extra'
-require 'bobkit/slim_extra'
+require 'bobkit/sass_bridge'
+require 'bobkit/slim_bridge'
+require 'bobkit/coffee_bridge'
+require 'bobkit/assets'
+
 require 'bobkit/scope'
 require 'bobkit/actions'

data/lib/bobkit/actions.rb

@@ -1,27 +1,11 @@
 module Bobkit
   module Actions
-    include SassExtra
-    include SlimExtra
-
-    def templates_folder(path=nil)
-      setopt :templates_folder, path, 'templates'
-    end
-
-    def layouts_folder(path=nil)
-      setopt :layouts_folder, path, "#{templates_folder}/layouts"
-    end
-
-    def styles_folder(path=nil)
-      setopt :styles_folder, path, 'styles'
-    end
-
-    def output_folder(path=nil)
-      setopt :output_folder, path, 'output'
-    end
-
-    def css_output_folder(path=nil)
-      setopt :css_output_folder, path, "#{output_folder}/css"
-    end
+    include OptionsBase
+    include LocationOptions
+    include SassBridge
+    include SlimBridge
+    include CoffeeBridge
+    include Assets
 
     def slim_options(options=nil)
       setopt :slim_options, options, slim_defaults
@@ -35,10 +19,6 @@ module Bobkit
       scope ? setopt(:scope, Scope.new(scope)) : options[:scope]
     end
 
-    def use_defaults
-      @@options = {}
-    end
-
     protected
 
     def slim_defaults
@@ -46,17 +26,9 @@ module Bobkit
     end
 
     def scss_defaults
-      { cache: true, syntax: :scss, style: :nested } 
+      { cache: true, syntax: :scss, style: :nested, 
+        load_paths: [styles_folder] } 
     end
 
-    def setopt(key, value=nil, default=nil)
-      options[key] = value if value
-      options[key] ||= default
-      options[key]
-    end
-
-    def options
-      @@options ||= {}
-    end
   end
 end

data/lib/bobkit/assets.rb

@@ -0,0 +1,14 @@
+module Bobkit
+  module Assets
+    include FileHelpers
+
+    def copy_asset(source, target=nil)
+      if target
+        target = "#{output_folder}/#{target}"
+      else
+        target = "#{assets_output_folder}/#{source}"
+      end
+      copy_entry "#{assets_folder}/#{source}", target
+    end
+  end
+end

data/lib/bobkit/coffee_bridge.rb

@@ -0,0 +1,13 @@
+module Bobkit
+  module CoffeeBridge
+    include FileHelpers
+
+    def compile_js(file, options={})
+      @file = "#{coffee_folder}/#{file}.coffee"
+      content = CoffeeScript.compile File.read @file
+      output = options[:output]
+      create_file "#{js_output_folder}/#{output}.js", content if output
+      content
+    end
+  end
+end

data/lib/bobkit/file_helpers.rb

@@ -1,13 +1,24 @@
 module Bobkit
   module FileHelpers
+    def create_folder(path)
+      FileUtils.mkdir_p(path) unless File.directory?(path)
+    end
+
+    def create_folder_for(path)
+      create_folder File.dirname(path)
+    end
+
     def create_file(path, content)
       create_folder_for path
       File.write path, content
     end
 
-    def create_folder_for(path)
-      dir = File.dirname path
-      FileUtils.mkdir_p(dir) unless File.directory?(dir)
+    def copy_file(source, target)
+      create_folder_for target
+      FileUtils.copy_entry source, target
     end
+    alias_method :copy_folder, :copy_file
+    alias_method :copy_entry, :copy_file
+
   end
 end

data/lib/bobkit/location_options.rb

@@ -0,0 +1,41 @@
+module Bobkit
+  module LocationOptions
+    include OptionsBase
+
+    def templates_folder(path=nil)
+      setopt :templates_folder, path, 'templates'
+    end
+
+    def layouts_folder(path=nil)
+      setopt :layouts_folder, path, "#{templates_folder}/layouts"
+    end
+
+    def styles_folder(path=nil)
+      setopt :styles_folder, path, 'styles'
+    end
+
+    def coffee_folder(path=nil)
+      setopt :coffee_folder, path, 'coffee'
+    end
+
+    def output_folder(path=nil)
+      setopt :output_folder, path, 'output'
+    end
+
+    def css_output_folder(path=nil)
+      setopt :css_output_folder, path, "#{output_folder}/css"
+    end
+
+    def js_output_folder(path=nil)
+      setopt :js_output_folder, path, "#{output_folder}/js"
+    end
+
+    def assets_folder(path=nil)
+      setopt :assets_folder, path, 'assets'
+    end
+
+    def assets_output_folder(path=nil)
+      setopt :assets_output_folder, path, "#{output_folder}/assets"
+    end
+  end
+end

data/lib/bobkit/options_base.rb

@@ -0,0 +1,19 @@
+module Bobkit
+  module OptionsBase
+    def use_defaults
+      @@options = {}
+    end
+
+    protected
+
+    def setopt(key, value=nil, default=nil)
+      options[key] = value if value
+      options[key] ||= default
+      options[key]
+    end
+
+    def options
+      @@options ||= {}
+    end
+  end
+end

data/lib/bobkit/{sass_extra.rb → sass_bridge.rb}

@@ -1,10 +1,11 @@
 module Bobkit
-  module SassExtra
+  module SassBridge
     include FileHelpers
 
     def compile_css(file, options={})
       @file = "#{styles_folder}/#{file}.scss"
-      content = Sass::Engine.new(File.read(@file), scss_options).render
+      extended_options = scss_options.merge({ filename: @file })
+      content = Sass::Engine.new(File.read(@file), extended_options).render
       output = options[:output]
       create_file "#{css_output_folder}/#{output}.css", content if output
       content

data/lib/bobkit/scope.rb

@@ -1,6 +1,6 @@
 module Bobkit
   class Scope
-    include SlimExtra
+    include SlimBridge
 
     def initialize(scope)
       @scope = scope

data/lib/bobkit/{slim_extra.rb → slim_bridge.rb}

@@ -1,5 +1,5 @@
 module Bobkit
-  module SlimExtra
+  module SlimBridge
     include FileHelpers
 
     def render(options={}, extra_options={})

data/lib/bobkit/version.rb

@@ -1,3 +1,3 @@
 module Bobkit
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bobkit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-15 00:00:00.000000000 Z
+date: 2016-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slim
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: sass-globbing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: coffee-script
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: runfile
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +94,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-description: Site Generation Toolkit with Slim, SCSS and CoffeeScript
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+description: Lightweight Site Generation Toolkit with Slim, SCSS and CoffeeScript
 email: db@dannyben.com
 executables: []
 extensions: []
@@ -75,10 +117,14 @@ files:
 - README.md
 - lib/bobkit.rb
 - lib/bobkit/actions.rb
+- lib/bobkit/assets.rb
+- lib/bobkit/coffee_bridge.rb
 - lib/bobkit/file_helpers.rb
-- lib/bobkit/sass_extra.rb
+- lib/bobkit/location_options.rb
+- lib/bobkit/options_base.rb
+- lib/bobkit/sass_bridge.rb
 - lib/bobkit/scope.rb
-- lib/bobkit/slim_extra.rb
+- lib/bobkit/slim_bridge.rb
 - lib/bobkit/version.rb
 homepage: https://github.com/DannyBen/bobkit
 licenses: