bobkit 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7db6c694ea1adaf5fec4c8dab145d0204744aca3
-  data.tar.gz: 369d8e39afb9dea61523f7f8208283946d840b9f
+  metadata.gz: ded1105026bb28b99fef542edb1421bbeb61d6a4
+  data.tar.gz: 4f544c6cc88490ebcbbc42417a1e0a906e9cc594
 SHA512:
-  metadata.gz: ed1294af999ff86255b1fd08091085478b19c3440955c706b220de5ed0dd86b029b3be09974cc9a36376a3691d5b8201fa2842600cc0a6214bc9134b1712a458
-  data.tar.gz: f88938070983f3e62cbf2705449a66de85b4d5512624851d93e1b76b03ee85728b79634e94d42930a6a44d6ff10a171c93db607062e182a51c065ec653641890
+  metadata.gz: b17f6df9d253d6067e3503d1b28f28b9978ccf25efac452aa2dd8a6c28676a75ba46755a5d67d201b448acae18d430d2696244171e1a4a442da287ac9378c1df
+  data.tar.gz: b815b313bbad1238f78e3cbe0929f4c9075f790bd512c6396dbfe89683608688769ba7feee9fa02f7887d558e18da79de57ff75315ca4e4b052beade5b1a4716

data/README.md

@@ -19,7 +19,7 @@ The design intentions were:
 - 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).
+- To add `@import 'globbing/*'` support to SCSS (Rails-like).
 
 ---
 
@@ -50,7 +50,7 @@ The basic usage pattern is this:
 
 ```ruby
 require 'bobkit'
-include Bobkit::Actions
+include Bobkit::Tasks
 
 # Convert Slim to HTML string
 html = render 'youtube', video: 'hi9tOILaiNs'
@@ -190,12 +190,34 @@ create_folder_for 'some/folder/with/file.png'
 ```
 
 
+### File Watcher
+
+Bobkit comes bundled with FileWatcher, and has a shortcut method to 
+use it.
+
+```ruby
+include Bobkit::Watcher
+
+watch do |filename, event|
+  puts "#{event}: #{filename}"
+  generate
+end
+
+def generate
+  # Your generation logic here
+end
+```
+
+The watch command is just like 
+`FileWatcher.new([...]).watch() do |filename, event|`
+with the exception that the array of paths to watch is optional. If none
+provided, we will watch all the input folders.
+
 Todo
 --------------------------------------------------
 
 - [ ] YAML loader (data_folder?)
 - [ ] CSV Loader (data_folder?)
-- [ ] Maybe: Include file watcher and auto generate
 - [ ] Maybe: Render from/to Markdown
 - [ ] Maybe: Render to JSON
 

data/lib/bobkit.rb

@@ -3,14 +3,19 @@ require 'sass'
 require 'sass-globbing'
 require 'slim'
 require 'coffee_script'
+require 'filewatcher'
 
 require 'bobkit/options_base'
 require 'bobkit/location_options'
 require 'bobkit/file_helpers'
+require 'bobkit/scope_options'
+require 'bobkit/sass_options'
 require 'bobkit/sass_bridge'
+require 'bobkit/slim_options'
 require 'bobkit/slim_bridge'
 require 'bobkit/coffee_bridge'
 require 'bobkit/assets'
+require 'bobkit/watcher'
 
 require 'bobkit/scope'
-require 'bobkit/actions'
+require 'bobkit/tasks'

data/lib/bobkit/sass_bridge.rb

@@ -1,6 +1,7 @@
 module Bobkit
   module SassBridge
     include FileHelpers
+    include SassOptions
 
     def compile_css(file, options={})
       @file = "#{styles_folder}/#{file}.scss"

data/lib/bobkit/sass_options.rb

@@ -0,0 +1,16 @@
+module Bobkit
+  module SassOptions
+    def scss_options(options=nil)
+      setopt :scss_options, options, scss_defaults
+    end
+    alias_method :sass_options, :scss_options
+
+
+    protected 
+
+    def scss_defaults
+      { cache: true, syntax: :scss, style: :nested, 
+        load_paths: [styles_folder] } 
+    end
+  end
+end

data/lib/bobkit/scope_options.rb

@@ -0,0 +1,9 @@
+module Bobkit
+  module ScopeOptions
+    include OptionsBase
+
+    def scope(scope=nil)
+      scope ? setopt(:scope, Scope.new(scope)) : options[:scope]
+    end
+  end
+end

data/lib/bobkit/slim_bridge.rb

@@ -1,6 +1,7 @@
 module Bobkit
   module SlimBridge
     include FileHelpers
+    include SlimOptions
 
     def render(options={}, extra_options={})
       options = { partial: options }.merge(extra_options) if options.is_a? String

data/lib/bobkit/slim_options.rb

@@ -0,0 +1,13 @@
+module Bobkit
+  module SlimOptions
+    def slim_options(options=nil)
+      setopt :slim_options, options, slim_defaults
+    end
+
+    protected 
+
+    def slim_defaults
+      { pretty: true, disable_escape: true }
+    end
+  end
+end

data/lib/bobkit/tasks.rb

@@ -0,0 +1,13 @@
+module Bobkit
+  module Tasks
+    include OptionsBase
+    include LocationOptions
+    include SassBridge
+    include SlimBridge
+    include CoffeeBridge
+    include SlimOptions
+    include SassOptions
+    include ScopeOptions
+    include Assets
+  end
+end

data/lib/bobkit/version.rb

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

data/lib/bobkit/watcher.rb

@@ -0,0 +1,27 @@
+module Bobkit
+  module Watcher
+    def watch(paths=nil, &block)
+      # :nocov:
+      @paths = paths
+      filewatcher.watch &block
+      # :nocov:
+    end
+
+    def filewatcher
+      FileWatcher.new(paths)
+    end
+
+    protected
+
+    def paths
+      @paths ||= all_input_paths
+    end
+
+    def all_input_paths
+      [ templates_folder, layouts_folder, styles_folder, 
+        coffee_folder, assets_folder ]
+    end
+  end
+end
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bobkit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: runfile
   requirement: !ruby/object:Gem::Requirement
@@ -116,16 +130,20 @@ extra_rdoc_files: []
 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/location_options.rb
 - lib/bobkit/options_base.rb
 - lib/bobkit/sass_bridge.rb
+- lib/bobkit/sass_options.rb
 - lib/bobkit/scope.rb
+- lib/bobkit/scope_options.rb
 - lib/bobkit/slim_bridge.rb
+- lib/bobkit/slim_options.rb
+- lib/bobkit/tasks.rb
 - lib/bobkit/version.rb
+- lib/bobkit/watcher.rb
 homepage: https://github.com/DannyBen/bobkit
 licenses:
 - MIT

data/lib/bobkit/actions.rb

@@ -1,34 +0,0 @@
-module Bobkit
-  module Actions
-    include OptionsBase
-    include LocationOptions
-    include SassBridge
-    include SlimBridge
-    include CoffeeBridge
-    include Assets
-
-    def slim_options(options=nil)
-      setopt :slim_options, options, slim_defaults
-    end
-
-    def scss_options(options=nil)
-      setopt :scss_options, options, scss_defaults
-    end
-
-    def scope(scope=nil)
-      scope ? setopt(:scope, Scope.new(scope)) : options[:scope]
-    end
-
-    protected
-
-    def slim_defaults
-      { pretty: true, disable_escape: true }
-    end
-
-    def scss_defaults
-      { cache: true, syntax: :scss, style: :nested, 
-        load_paths: [styles_folder] } 
-    end
-
-  end
-end