burek 0.5.5 → 0.5.9

data/README.md

@@ -1,4 +1,78 @@
-burek
-=====
+# burek
+
+Burek is here to help you with your RoR translations. It's not here to replace rails translation, but to help you manage them. In the end *all* burek calls are replaced with regular translation calls.
+
+## How it works?
+
+### 1. Call burek in your view files 
+
+```html
+# views/users/index.html
+<h1>
+  <%= burek("All users") %>
+</h1>
+```
+
+### 2. Fetch translations with burek rake task
+
+```bash
+rake burek:fetch
+```
+
+### 3. Burek generates translation files for you.
+If you defined, for example, you want to use English and Finnish locales (and English is your main locale).
+
+```ruby
+# config/locales/burek/views/users/index.en.yml
+en:
+  views:
+    users:
+      all_users: All users
+```
+
+```ruby
+# config/locales/burek/views/users/index.fi.yml
+en:
+  views:
+    users:
+      all_users: TODO
+```
+
+It also replaces all burek calls with regular translation calls
+
+```html
+# views/users/index.html
+<h1>
+  <%= t("views.users.all_users") %>
+</h1>
+```
+
+That's it!
+
+## How to install it?
+
+Just add following line to your Gemfile:
+```ruby
+gem "burek"
+```
+## How to configure it?
+You can use default configuration, if you want to override it create following file. You don't have to override all configuration variables, but I listed them all here with brief descriptions. 
+
+```ruby
+# config/initializers/burek.rb
+Burek.setup do |config|
+  config.search_folders = ['./app/views/**/*'] # Where should I look for burek calls?
+  config.translations_path = './config/locales/burek/' # Where should I generate translation files?
+  config.translation_placeholder = 'TODO' # What should I set as default translation for non-main languages
+  config.locales = ['en'] # What locales do you want to use? (NOTE: First locale is considered main)
+
+  # NOTE: Burek generates your translation keys depending on file path where burek call was found.
+  config.ignore_folders_for_key = ['.','app'] # What folders should be ignored when generating translation key
+
+  # NOTE: When generating locale files they are nested in subfolders that are generated from translation key
+  config.subfolder_depth = 2 # How deep should I nest translation files in subfolders?
+end
+```
+
+
 
-A ruby/rails gem for managing translations easy way.

data/lib/burek.rb

@@ -1,4 +1,6 @@
+# encoding: UTF-8
 require 'rails/view_helpers'
+require 'core/core'
 
 module Burek
   class Railtie < Rails::Railtie

data/lib/config.rb

@@ -1,21 +1,47 @@
+require 'yaml'
+
 module Burek
 
-  @@config_hash = {
+  class BurekConfiguration
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def hash
+      @hash
+    end
+
+    def get(key)
+      hash[key]
+    end
+
+    def method_missing(m, *args, &block)
+      key = m.to_s.gsub('=','').to_sym
+      raise 'Unknown config key!' unless @hash.has_key? key
+      @hash[key] = args.first
+    end
+  end
+
+  @@configuration = BurekConfiguration.new({
     search_folders: ['./app/views/**/*'],
     translations_path: './config/locales/burek/',
     translation_placeholder: 'TODO',
     ignore_folders_for_key: ['.','app'],
     subfolder_depth: 2,
-    locales: ['en','fi']
-  }
+    locales: ['en']
+  })
 
-  def self.set_config(key, value)
-    @@config_hash[key] = value
+  def self.setup
+    yield @@configuration
   end
-  
-  def self.config(key)
-    raise 'Unknown config key!' unless @@config_hash.has_key? key
-    @@config_hash[key]
+
+  def self.configuration
+    @@configuration
+  end
+
+  def self.config
+    configuration
   end
   
 end
+

data/lib/core/burek_finder.rb

@@ -15,13 +15,17 @@ module Burek
         filtered_path = filter_path(file_name)
         matches = find_burek_calls(contents)
         matches.each do |caption|
-          key = filtered_path + "/" + caption.downcase.gsub(' ','_')
+          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
     #
@@ -46,7 +50,7 @@ module Burek
     def self.filter_path(file_name)
       path = file_name.split('/')
       path.delete_if do |item|
-        Burek.config(:ignore_folders_for_key).include? item
+        Burek.config.get(:ignore_folders_for_key).include? item
       end
       path.last.gsub!(/\.(.*?)$/,'').gsub!(/^_/,'') #strip extenison from file name
       return path.join('/')

data/lib/core/core.rb

@@ -16,11 +16,25 @@ module Burek
     # 3. replace all burek calls with regular translation calls
     #
     def self.run_burek
-      Burek::FileHelpers.create_folder_if_missing Burek.config(:translations_path)
+      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}'"
+        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)
+
+      puts "DONE!"
     end
 
     # A regex for finiding burek calls

data/lib/core/locales_creator.rb

@@ -14,7 +14,7 @@ module Burek
     def self.create_locales(new_translations)
       to_replace = {}
       # Create files for each locale
-      Burek.config(:locales).each do |locale|    
+      Burek.config.get(:locales).each do |locale|    
         new_translations.each do |key,value|
           path_parts = key.split("/")
           item_name = path_parts.pop
@@ -33,7 +33,7 @@ module Burek
             cur_hash[item] = {} unless cur_hash.has_key?(item)
             cur_hash = cur_hash[item]
           end
-          cur_hash[item_name] = ( locale == Burek.config(:locales).first ? value : Burek.config(:translation_placeholder) )
+          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)
@@ -72,12 +72,16 @@ module Burek
       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 += "#{item_name}"
+      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.
@@ -97,9 +101,9 @@ module Burek
       path_parts = key.split("/")
       path_parts.pop
 
-      translation_file = Burek.config(:translations_path) 
+      translation_file = Burek.config.get(:translations_path) 
       path_parts.each_with_index do |item, index|
-        if index == Burek.config(:subfolder_depth) || item == path_parts.last
+        if index == Burek.config.get(:subfolder_depth) || item == path_parts.last
           translation_file += "#{item}.#{locale}.yml"
           break
         else

data/lib/file_helpers.rb

@@ -11,7 +11,7 @@ module Burek
     end
 
     def self.for_each_file
-      Burek.config(:search_folders).each do |folder|
+      Burek.config.get(:search_folders).each do |folder|
         Dir.glob(folder) do |file_name|
           unless File.directory?(file_name)
              yield file_name

data/tasks/tasks.rb

@@ -5,9 +5,14 @@ require 'config'
 namespace :burek do
 
   desc "Task passes through all views and reports any missing translations"
-  task :fetch do
+  task :fetch => :environment do
     Burek::Core.run_burek
   end
+
+  desc "Show loaded configuration"
+  task :show_config => :environment do
+    puts Burek.configuration.hash
+  end
   
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: burek
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.9
   prerelease: 
 platform: ruby
 authors: