bobkit 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 026b002977ac0ef09bb4a46f6d6a50b05fabab6f
-  data.tar.gz: 449e2f8ff40f0b8fc38cf9a808a49c54fcc72235
+  metadata.gz: 13c8f2ec6ec081beb417ccb392b47539caf923ef
+  data.tar.gz: 67851f24c8ed1e80d2851079a7680d1cbc90b5b2
 SHA512:
-  metadata.gz: 5851936138b638b507bdf382a6d8a2a467c4e7f45a5b7666fcdc5065015745f744ab41c610656e708b9de4a842d169c79bd472f185657c1c4904d012569b8178
-  data.tar.gz: 3d309f88de78e6cf58dc521f3c6d7d99b239860f0f2ac47b9bc1ec3c43d46131b3372aee514767a8e34556e4111a9ccda8c14da6db6fcf36cf23faca29512b4b
+  metadata.gz: ed328b74351587d7e0320310b4a4b52cb1985f22d6a0c76174167a051df3cb9f21c2b1d7094ad171bb24f874ed0f3341c8758ef34990af08cb093727ece3f30f
+  data.tar.gz: c0140b94f48370f96b621b140b1713c569d8469c805f639a43cb957d313ffdf59317bb6103ca570b3a0a51e57ed97b4b9306737eb55e7f19954fb573be0655ef

data/README.md

@@ -19,6 +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 i18n support to Slim (Rails-like).
 - To add `@import 'globbing/*'` support to SCSS (Rails-like).
 
 ---
@@ -89,6 +90,9 @@ layouts_folder 'my_layouts'
 # Location of the source SCSS files. Default: "styles"
 styles_folder 'styles'
 
+# Location of locale configuration files. Default: "locales"
+locales_folder 'locales'
+
 # Output location. Default: "output"
 output_folder 'site'
 
@@ -133,6 +137,9 @@ html = render 'user', layout: 'default', email: 'bob@kit.com'
 render 'user', layout: 'default', email: 'bob@kit.com', output: 'bob'
 ```
 
+In addition, you can call `= render 'template'` from inside a slim 
+template.
+
 
 ### SCSS
 
@@ -169,6 +176,18 @@ copy_asset 'presskit.zip'
 copy_asset 'images'
 ```
 
+### Internationalization (I18n)
+
+Bobkit supports these i18n features:
+
+- Set the folder for your localization files with `locales_folder` 
+  (default: 'locales').
+- You can call `= t('common.hello')` from a slim template.
+- You can call `= l(Time.now)` from a slim template.
+- Any call to `render 'template_name'` will first look for a localized
+  version of the file (`template_name.en.slim`) and will use it if found.
+  Otherwise, it will use the unlozalized filename (`template_name.slim`).
+
 
 ### Low level file and folder helpers
 

data/lib/bobkit/i18n_bridge.rb

@@ -0,0 +1,25 @@
+module Bobkit
+  module I18nBridge
+    include I18nMixin
+
+    def locale(language=nil)
+      I18nHandler.instance.locale language if language
+      I18n.locale
+    end
+
+    class I18nHandler
+      include Singleton
+      include LocationOptions
+
+      def initialize
+        I18n.load_path = Dir["#{locales_folder}/**/*.yml"]
+        I18n.backend.load_translations
+      end
+
+      def locale(language)
+        I18n.locale = language
+      end
+    end
+    
+  end
+end

data/lib/bobkit/i18n_mixin.rb

@@ -0,0 +1,11 @@
+module Bobkit
+  module I18nMixin
+    def t(*args)
+      I18n.t *args
+    end
+
+    def l(*args)
+      I18n.l *args
+    end
+  end
+end

data/lib/bobkit/location_options.rb

@@ -37,5 +37,9 @@ module Bobkit
     def assets_output_folder(path=nil)
       setopt :assets_output_folder, path, "#{output_folder}/assets"
     end
+
+    def locales_folder(path=nil)
+      setopt :locales_folder, path, "locales"
+    end
   end
 end

data/lib/bobkit/options_base.rb

@@ -1,19 +1,31 @@
 module Bobkit
   module OptionsBase
     def use_defaults
-      @@options = {}
+      OptionsHandler.instance.options = {}
     end
 
-    protected
-
-    def setopt(key, value=nil, default=nil)
-      options[key] = value if value
-      options[key] ||= default
-      options[key]
+    def setopt(*args)
+      OptionsHandler.instance.setopt *args
     end
 
     def options
-      @@options ||= {}
+      OptionsHandler.instance.options
+    end
+
+    class OptionsHandler
+      include Singleton
+
+      attr_accessor :options
+
+      def initialize
+        @options = {}
+      end
+
+      def setopt(key, value=nil, default=nil)
+        options[key] = value if value
+        options[key] ||= default
+        options[key]
+      end
     end
   end
 end

data/lib/bobkit/sass_options.rb

@@ -5,9 +5,6 @@ module Bobkit
     end
     alias_method :sass_options, :scss_options
 
-
-    protected 
-
     def scss_defaults
       { cache: true, syntax: :scss, style: :nested, 
         load_paths: [styles_folder] } 

data/lib/bobkit/scope.rb

@@ -1,6 +1,7 @@
 module Bobkit
   class Scope
     include SlimBridge
+    include I18nMixin
 
     def initialize(scope=nil)
       @scope = scope || {}

data/lib/bobkit/slim_bridge.rb

@@ -1,25 +1,50 @@
 module Bobkit
   module SlimBridge
-    include FileHelpers
-    include SlimOptions
-    include LocationOptions
-    include ScopeOptions
-
-    def render(options={}, extra_options={})
-      options = { partial: options }.merge(extra_options) if options.is_a? String
-      partial = options.delete :partial
-      layout  = options.delete :layout
-      output  = options.delete :output
-      
-      context = options.empty? ? scope : options
-      if context.is_a? Hash or !context
-        context = Scope.new context 
+    def render(*args)
+      SlimHandler.instance.render *args
+    end
+
+    class SlimHandler
+      include Singleton
+      include FileHelpers
+      include SlimOptions
+      include LocationOptions
+      include ScopeOptions
+      include I18nBridge
+
+      def render(options={}, extra_options={})
+        options = { partial: options }.merge(extra_options) if options.is_a? String
+        partial = options.delete :partial
+        layout  = options.delete :layout
+        output  = options.delete :output
+        
+        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(layout_filename(layout), slim_options).render(context) { content } if layout
+        create_file "#{output_folder}/#{output}.html", content if output
+        content
       end
 
-      content = Slim::Template.new("#{templates_folder}/#{partial}.slim", slim_options).render(context)
-      content = Slim::Template.new("#{layouts_folder}/#{layout}.slim", slim_options).render(context) { content } if layout
-      create_file "#{output_folder}/#{output}.html", content if output
-      content
+      private
+
+      def partial_filename(partial)
+        localized_template templates_folder, partial
+      end
+
+      def layout_filename(layout)
+        localized_template layouts_folder, layout
+      end
+
+      def localized_template(folder, basename)
+        preferred = "#{folder}/#{basename}.#{locale}.slim"
+        return preferred if File.exist? preferred
+        "#{folder}/#{basename}.slim"
+      end
     end
+
   end
-end
+end

data/lib/bobkit/slim_options.rb

@@ -4,8 +4,6 @@ module Bobkit
       setopt :slim_options, options, slim_defaults
     end
 
-    protected 
-
     def slim_defaults
       { pretty: true, disable_escape: true }
     end

data/lib/bobkit/tasks.rb

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

data/lib/bobkit/version.rb

@@ -1,3 +1,3 @@
 module Bobkit
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/bobkit/watcher.rb

@@ -1,27 +1,41 @@
 module Bobkit
   module Watcher
-    def watch(paths=nil, &block)
+    def watch(*args)
       # :nocov:
-      @paths = paths
-      filewatcher.watch &block
+      FileWatcherHandler.instance.watch *args
       # :nocov:
     end
 
     def filewatcher
-      FileWatcher.new(paths)
+      FileWatcherHandler.instance.filewatcher
     end
 
-    protected
+    class FileWatcherHandler
+      include Singleton
+      include LocationOptions
 
-    def paths
-      @paths ||= all_input_paths
-    end
+      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, locales_folder ]
+      end
 
-    def all_input_paths
-      [ templates_folder, layouts_folder, styles_folder, 
-        coffee_folder, assets_folder ]
     end
   end
 end
-
-

data/lib/bobkit.rb

@@ -1,3 +1,4 @@
+require 'i18n'
 require 'fileutils'
 require 'sass'
 require 'sass-globbing'
@@ -8,6 +9,8 @@ require 'filewatcher'
 require 'bobkit/options_base'
 require 'bobkit/location_options'
 require 'bobkit/file_helpers'
+require 'bobkit/i18n_mixin'
+require 'bobkit/i18n_bridge'
 require 'bobkit/scope_options'
 require 'bobkit/sass_options'
 require 'bobkit/sass_bridge'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bobkit
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2016-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slim
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: filewatcher
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +147,8 @@ files:
 - lib/bobkit/assets.rb
 - lib/bobkit/coffee_bridge.rb
 - lib/bobkit/file_helpers.rb
+- lib/bobkit/i18n_bridge.rb
+- lib/bobkit/i18n_mixin.rb
 - lib/bobkit/location_options.rb
 - lib/bobkit/options_base.rb
 - lib/bobkit/sass_bridge.rb