burek 0.5.9 → 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9cff03970830167bb22fb7c2abc148f0de082ebf
+  data.tar.gz: f972fc14ae5e046b12395a64ba7762d98cd5d5a1
+SHA512:
+  metadata.gz: 1eaccdc6a2d8aff70ad57a7ba9728445692e0ebf251e79afec6aaa4eb4cf3ede1311f047871fff2c3cc8c107cfaf93c4e4a2332f2e0e36daf8c4814c4a859217
+  data.tar.gz: 553961b8f66205529f3c7c381a9db769711a3deb5cb1d7c7a1ca99de9fe9411dc17233516afbc4f75f623bf4c61d61da39551960458e3f1804415b8a320f825d

data/README.md

@@ -25,17 +25,13 @@ If you defined, for example, you want to use English and Finnish locales (and En
 ```ruby
 # config/locales/burek/views/users/index.en.yml
 en:
-  views:
-    users:
-      all_users: All users
+  all_users: All users
 ```
 
 ```ruby
 # config/locales/burek/views/users/index.fi.yml
 en:
-  views:
-    users:
-      all_users: TODO
+  all_users: TODO
 ```
 
 It also replaces all burek calls with regular translation calls
@@ -43,12 +39,40 @@ It also replaces all burek calls with regular translation calls
 ```html
 # views/users/index.html
 <h1>
-  <%= t("views.users.all_users") %>
+  <%= t("all_users") %>
 </h1>
 ```
 
 That's it!
 
+## Additional options
+
+You can also pass a hash as second argument to burek call.
+
+```html
+# views/users/index.html
+<h1>
+  <%= burek("All users", {key: 'users', parent_key: 'levelone.leveltwo'}) %>
+</h1>
+```
+
+This call will generate following translation file:
+
+```ruby
+# config/locales/burek/views/users/index.fi.yml
+en:
+  levelone:
+    leveltwo:
+      users: "All users"
+```
+
+```html
+# views/users/index.html
+<h1>
+  <%= t("levelone.leveltwo.users") %>
+</h1>
+```
+
 ## How to install it?
 
 Just add following line to your Gemfile:

data/lib/config.rb

@@ -24,7 +24,7 @@ module Burek
 
   @@configuration = BurekConfiguration.new({
     search_folders: ['./app/views/**/*'],
-    translations_path: './config/locales/burek/',
+    translations_path: './config/locales/',
     translation_placeholder: 'TODO',
     ignore_folders_for_key: ['.','app'],
     subfolder_depth: 2,

data/lib/core/burek_call.rb

@@ -0,0 +1,55 @@
+module Burek
+  class BurekCall
+
+    def initialize(translation, options={})
+      if translation.is_a?(Hash)
+        @translation = translation
+      else
+        @translation = {default_locale => translation }
+      end
+      @key = options[:key] || key_from_translation
+      @parent_key = options[:parent_key] || ''
+    end
+
+    def translation(locale=nil)
+      locale ||= default_locale
+      locale = locale.to_s
+      if @translation.has_key?(locale)
+        return @translation[locale]
+      else
+        return Burek.config.get(:translation_placeholder)
+      end
+    end
+
+    def key
+      @key
+    end
+
+    def parent_key
+      @parent_key
+    end
+
+    def full_key
+      if parent_key.nil? || parent_key.length == 0
+        key
+      else
+        parent_key + "." + key
+      end
+    end
+
+    def parent_key_array
+      @parent_key.split('.')
+    end
+
+    private
+
+    def key_from_translation
+      translation.downcase.gsub(' ','_')
+    end
+
+    def default_locale
+      Burek.config.get(:locales).first
+    end
+
+  end
+end

data/lib/core/core.rb

@@ -1,8 +1,8 @@
 require 'config'
 require 'yaml'
-require 'core/burek_replacer'
-require 'core/burek_finder'
-require 'core/locales_creator'
+require 'core/burek_call'
+require 'core/translations_store'
+
 require 'file_helpers'
 
 module Burek
@@ -19,38 +19,58 @@ module Burek
       Burek::FileHelpers.create_folder_if_missing Burek.config.get(:translations_path)
 
       puts "Searching for burek calls..."
-      new_translations = Burek::Finder.find_burek_calls_in_files
-      if new_translations.any?
-        new_translations.each do |file, caption|
-          puts "\t-> Found '#{caption}' in '#{file}'"
+      
+      # Initializing translations store
+      translations = TranslationsStore.new
+      Burek.config.get(:locales).each do |locale|
+        filename = "burek.#{locale}.yml"
+        file_path = Burek.config.get(:translations_path) + filename
+        translations.load_locale locale, file_path
+      end
+
+      # Replacing calls and updating translations hash
+      Burek::FileHelpers.open_each_file do |contents, file_name|      
+        matches = fetch_params_from_string(contents)
+        matches.each do |call_params|
+          call = burek_call_from_params_string call_params
+          translations.push_call call
+          contents.gsub!(burek_call_params_regex(call_params),"t('#{call.full_key}')")           
+        end
+        File.open(file_name, "w:UTF-8") do |f| 
+          f.write contents
         end
-      else
-        puts "No burek calls found!"
       end
-      
-      puts "Adding translations to locale filess..."
-      to_replace = Burek::LocalesCreator.create_locales(new_translations)
-      
-      puts "Repalcing burek calls with translation calls..."
-      Burek::Replacer.replace_burek_calls_in_files(to_replace)
+
+      # Saving new translations
+      Burek.config.get(:locales).each do |locale|
+        filename = "burek.#{locale}.yml"
+        file_path = Burek.config.get(:translations_path) + filename
+        translations.save_locale locale, file_path
+      end
 
       puts "DONE!"
     end
 
+    def self.store_burek_call_to_locale_file(call)
+      Burek.config.get(:locales).each do |locale|
+        translations_hash_to_file translation_hash, file_path
+      end 
+    end
+
+    def self.fetch_params_from_string(string)
+      string.scan(self.burek_call_params_regex).flatten
+    end
+
+    def self.burek_call_from_params_string(params)
+      call = "BurekCall.new(#{params})"
+      eval call
+    end
+
+    private
+
     # A regex for finiding burek calls
-    # 
-    # It is used by Burek::Finder and Burek::Replacer.
-    # Example calls it can find
-    # * burek('Hello world')
-    # * burek("Hello world")
-    # * burek ( "Hello world" )
-    #
-    # ==== Attributes
-    # * +caption+ - Use it to find burek call with specific caption.
-    #               By default it will accept any string and capture it in group named 'key'.
-    #
-    def self.burek_call_regex(caption="(?<key>[^\\)]*)")
-      Regexp.new("[^a-zA-Z0-9_]burek[ \\t]*\\([ \\t]*('|\")#{caption}\('|\")[^\\)]*\\)")
+    def self.burek_call_params_regex(caption='([^\)]*)')
+      /burek *\(#{caption}\)/
     end
     
   end

data/lib/core/translations_store.rb

@@ -0,0 +1,59 @@
+module Burek
+
+  class TranslationsStore
+
+    def initialize(translations_hash={})
+      @translations_hash = translations_hash
+    end
+
+    def load_locale(locale, file_path)
+      locale = locale.to_s
+      if File.exists?(file_path)
+        @translations_hash = YAML::load_file(file_path) #Load
+      else
+        @translations_hash[locale] = {} 
+      end
+    end
+
+    def save_locale(locale, file_path)
+      locale = locale.to_s
+      File.open(file_path, "w:UTF-8") do |f| 
+        f.write locale_yaml(locale)
+      end
+    end
+
+    def push_call(call)
+
+      Burek.config.get(:locales).each do |locale|
+        # In case it's a symbole convert it to string
+        locale = locale.to_s
+        
+        # Initialize hash for current locale
+        @translations_hash[locale] = {} unless @translations_hash.has_key?(locale)
+
+        # Nest hash
+        cur_hash = @translations_hash[locale]
+        call.parent_key_array.each do |item|
+          cur_hash[item] = {} unless cur_hash.has_key?(item)
+          cur_hash = cur_hash[item]
+        end
+        cur_hash[call.key] = call.translation(locale)
+      end
+
+    end
+
+    def get_hash
+      @translations_hash
+    end
+
+    private
+
+    def locale_yaml(locale)
+      yaml = {locale => @translations_hash[locale] }.to_yaml # Pluck only one top level key
+      clean_yaml = yaml.lines.to_a[1..-1].join # Clean up first line
+      return clean_yaml
+    end
+
+  end
+
+end

data/lib/rails/view_helpers.rb

@@ -2,7 +2,7 @@ module Burek
 
   module ViewHelpers
     def burek(key)
-      raw "<span class='translation_missing'>#{key}</span>"
+      raw "<span style='background-color:red;'>#{key}</span>"
     end
   end
 

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burek
 version: !ruby/object:Gem::Version
-  version: 0.5.9
-  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors:
 - Filip Defar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2014-09-20 00:00:00.000000000 Z
 dependencies: []
 description: Manage your translations the easy way.
 email: dabrorius@gmail.com
@@ -20,36 +19,34 @@ files:
 - tasks/tasks.rb
 - lib/burek.rb
 - lib/config.rb
-- lib/core/burek_finder.rb
-- lib/core/burek_replacer.rb
+- lib/core/burek_call.rb
 - lib/core/core.rb
-- lib/core/locales_creator.rb
+- lib/core/translations_store.rb
 - lib/file_helpers.rb
 - lib/rails/view_helpers.rb
 - README.md
 homepage: https://github.com/dabrorius/burek
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Manage your translations the easy way.
 test_files: []

data/lib/core/burek_finder.rb

@@ -1,60 +0,0 @@
-require 'file_helpers'
-
-module Burek
-  module Finder
-
-    # Searches all files within search folders for burek calls.
-    #
-    # ==== Returns
-    # Hash in whichs values represent burek call captions and keys represent locales file paths in which
-    # those captions were found
-    #
-    def self.find_burek_calls_in_files
-      new_translations = {}
-      Burek::FileHelpers.open_each_file do |contents, file_name|      
-        filtered_path = filter_path(file_name)
-        matches = find_burek_calls(contents)
-        matches.each do |caption|
-          key = filtered_path + "/" + caption_to_key_part(caption)
-          new_translations[key] = caption
-        end
-      end
-      return new_translations
-    end
-
-    # Sanitizes caption so that it can be used as key part
-    def self.caption_to_key_part(caption)
-      caption.strip.gsub(/ +/,' ').downcase.gsub(/[^0-9a-z_ ]/i, '').split(' ')[0..3].join('_')
-    end
-
-    # Finds burek calls in a string
-    #
-    # ==== Attributes
-    # * +string+ - A string that (possibly) contains burek calls
-    #
-    # ==== Returns
-    # Array of burek call captions
-    #
-    def self.find_burek_calls(string)
-      string.scan(Burek::Core.burek_call_regex).flatten 
-    end
-
-    # Removes file extension from a path as well as any folder that is specified as ignored folder in config
-    #
-    # ==== Attributes
-    # * +file_name+ - path in string format that needs to be filtered
-    #
-    # ==== Returns
-    # Filtered path as a string
-    #
-    def self.filter_path(file_name)
-      path = file_name.split('/')
-      path.delete_if do |item|
-        Burek.config.get(:ignore_folders_for_key).include? item
-      end
-      path.last.gsub!(/\.(.*?)$/,'').gsub!(/^_/,'') #strip extenison from file name
-      return path.join('/')
-    end
-
-  end
-end

data/lib/core/burek_replacer.rb

@@ -1,32 +0,0 @@
-require 'file_helpers'
-require 'core/burek_finder'
-
-module Burek
-  module Replacer
-
-    def self.replace_burek_calls_in_files(to_replace)
-      Burek::FileHelpers.open_each_file do |content,file_name|      
-        processed_content = replace_burek_calls(content, to_replace)
-        unless processed_content.nil?
-          File.open(file_name, 'w') do |output_file|
-            output_file.print processed_content
-          end
-        end
-      end
-    end
-
-    def self.replace_burek_calls(contents, to_replace)
-      matches = Burek::Finder.find_burek_calls(contents)
-      changes_made = false
-      matches.each do |value|
-        if to_replace.has_key?(value)
-          contents.gsub!(Burek::Core.burek_call_regex(value)," t('#{to_replace[value]}')") 
-          changes_made = true
-        end
-      end
-
-      return contents if changes_made
-    end
-
-  end
-end

data/lib/core/locales_creator.rb

@@ -1,120 +0,0 @@
-module Burek
-  module LocalesCreator
-
-    # Creates new or updates exisitng locales files. Called by Burek::Finder
-    #
-    # ==== Attributes
-    # * +new_translations+ - A hash of new translations that were found in search folders.
-    #                        Values represent burek call captions and keys represent locales file paths in which those captions were found.
-    #
-    # ==== Returns
-    # A hash of burek calls that need to be replaced by translation calls.
-    # Keys contain captions of burek calls and values contain key which translation keys should contain.
-    #
-    def self.create_locales(new_translations)
-      to_replace = {}
-      # Create files for each locale
-      Burek.config.get(:locales).each do |locale|    
-        new_translations.each do |key,value|
-          path_parts = key.split("/")
-          item_name = path_parts.pop
-          path_parts_no_filename = path_parts[0..-2]
-
-          translation_file = key_to_file_path(key, locale)
-          translations_hash = initialize_translations_hash(translation_file, locale)
-
-          # Save info for replacing burek calls with translation calls.
-          # Keys are burek call captions and values are keys to be used in translation calls.
-          to_replace[value] = path_parts_to_key(path_parts_no_filename, item_name)
-
-          # Nest in hashes
-          cur_hash = translations_hash[locale]
-          path_parts_no_filename.each do |item|
-            cur_hash[item] = {} unless cur_hash.has_key?(item)
-            cur_hash = cur_hash[item]
-          end
-          cur_hash[string_to_key(item_name)] = ( locale == Burek.config.get(:locales).first ? value : Burek.config.get(:translation_placeholder) )
-
-          # Save to file
-          Burek::LocalesCreator.translations_hash_to_file(translations_hash, translation_file)
-        end
-      end
-
-      return to_replace
-    end
-
-    # Stores a translation hash in to a file
-    #
-    def self.translations_hash_to_file(translations_hash, translation_file)
-      clean_yaml = yaml_to_i18n_file(translations_hash.to_yaml) 
-      translation_file.gsub!("//","/")
-      File.open(translation_file, "w:UTF-8") do |f| 
-        f.write clean_yaml
-      end
-    end
-
-    # Removes a first line from a yaml file which is added to standard YAML files
-    # but rails does not like it. It continas ---- or something like that
-    #
-    def self.yaml_to_i18n_file(yaml)
-      yaml.lines.to_a[1..-1].join
-    end
-  
-    # Intializes a translation hash by either loading existing translation file
-    # or creating a hash that contains an empty hash under key which is name of current locale.
-    def self.initialize_translations_hash(translation_file, locale)
-      if File.exists?(translation_file)
-        translations_hash = YAML::load_file(translation_file) #Load
-      else
-        translations_hash = {}
-        translations_hash[locale] = {} 
-      end
-      return translations_hash
-    end
-
-    def self.string_to_key(string)
-      string.split(' ')[0..3].join('_').downcase.gsub(/[^0-9a-z_]/i, '')
-    end
-
-    # Creates a translation call key from path where burek call was found and burek call caption
-    #
-    def self.path_parts_to_key(path_parts, item_name)
-      regular_translation_key = path_parts.join('.') 
-      regular_translation_key += "." unless regular_translation_key.nil? || regular_translation_key.empty?
-      regular_translation_key += "#{string_to_key(item_name)}"
-    end
-
-    # Generates a file path to locales file from a file path where burek call was found.
-    # It will nest locales file under same subfolders in which burek call was found.
-    # If burek call was nested deeper then defined as subfolder depth limit in config file
-    # it will nest it under first X folders (where x is subfolder depth limit)
-    #
-    # ==== Attributes
-    # * +key+ - file path where burek call was found
-    # * +locale+ - locale for which this file is created
-    #
-    # ==== Returns
-    # A string that contains a path where locale file should be created.
-    # NOTE: Even though subfolders are created, the actuall locale file is NOT created.
-    #
-    def self.key_to_file_path(key, locale)
-      path_parts = key.split("/")
-      path_parts.pop
-
-      translation_file = Burek.config.get(:translations_path) 
-      path_parts.each_with_index do |item, index|
-        if index == Burek.config.get(:subfolder_depth) || item == path_parts.last
-          translation_file += "#{item}.#{locale}.yml"
-          break
-        else
-          translation_file += "/#{item}/"
-          unless File.directory?(translation_file)
-            Dir.mkdir(translation_file)
-          end
-        end
-      end
-      return translation_file
-    end
-
-  end
-end