riddick 0.0.3 → 0.0.4

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
 /pkg
+.ruby-version

data/Gemfile

@@ -1,2 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
+
 gemspec

data/README.md

@@ -6,7 +6,7 @@ Friendly GUI for managing your I18n translations.
 
 By default it uses Redis as I18n backend for translations, but you can add your own key-value backend.
 
-![Screenshot](http://timeworkers-assets.s3.amazonaws.com/riddick.png)
+![Screenshot](https://raw.github.com/kostia/riddick/master/screenshot.png)
 
 ## Installation
 
@@ -70,7 +70,7 @@ riddick:
       default: 'Edit'
     delete: 'Delete'
     confirm: 'Are you sure?'
-  notice
+  notice:
     empty: 'You have no translations yet.'
     set:
       success: 'Translation successfully stored!'
@@ -191,6 +191,22 @@ __Details__: Normally your using a proxy server like NGinx or Apache in front of
 Unfortunately the assets from a mounted Sinatra app will not be served because
 they aren't in the `public` directory of your app.
 
+### You are using redis not only for storing translations
+
+If your are using redis to store other stuff you can separate your I18n translations in namespace. Please use redis-namespace gem.
+```ruby
+# Gemfile
+gem 'redis-namespace'
+```
+
+Change your configuration in i18n.rb
+```ruby
+#  config/initializers/i18n.rb
+I18n.backend = I18n::Backend::Chain.new I18n::Backend::KeyValue.new(Redis::Namespace.new(:riddick)), I18n.backend
+```
+
+Your I18n translations will be stored in `riddick` namespace.
+
 ## Internals
 
 Take a look at http://railscasts.com/episodes/256-i18n-backends

data/TODO-0.0.4

@@ -1,3 +1,5 @@
+* Pagination (see Sidekiq for details)
+* Change from Erb to Slim
 * API for writing own backends + examples for ActiveRecordBackend in README
 * Split Riddick::Server in Riddick::GuiServer and Riddick::ApiServer (JSON)
 * Build Rails-Engine
@@ -7,3 +9,5 @@
 * Simple URL-Helpers for:
   * Generating URL for editing, updating and deleting translations
   * Generating JS and HTML snippet for editing a translation
+
+- Sprockets // Will not be implemented for it's then too complicated in production

data/lib/riddick/server.rb

@@ -41,11 +41,20 @@ module Riddick
         url('del') + "?k=#{URI.escape k}"
       end
 
+      # Shortcut for namepspaces localization
+      def t(path, default = nil)
+        I18n.t "riddick.#{path}", default: default
+      end
+
       # Truncate a string with default length 30. Truncation string is '...' by default
       # and can be changed by changing the appropriate translation (see README for further details).
       def truncate(v, l = 30)
         s = v.to_s
-        s.size > l ? s.first(l) + I18n.t('riddick.truncation', default: '...') : s
+        s.size > l ? s.first(l) + t('truncation', '...') : s
+      end
+
+      def h(text)
+        Rack::Utils.escape_html(text)
       end
     end
 
@@ -77,11 +86,9 @@ module Riddick
       k, v = params[:k], params[:v]
       if k && v && !k.empty? && !v.empty?
         Riddick::Backends.store_translation k, v
-        session[:flash_success] = I18n.t('riddick.notice.set.success',
-                                         default: 'Translation successfully stored!')
+        session[:flash_success] = t('notice.set.success', 'Translation successfully stored!')
       else
-        session[:flash_error] = I18n.t('riddick.notice.set.error',
-                                       default: 'Error: either path or translation is empty!')
+        session[:flash_error] = t('notice.set.error', 'Error: either path or translation is empty!')
       end
       redirect my_url
     end
@@ -93,11 +100,9 @@ module Riddick
       k = params[:k]
       if k && !k.empty?
         Riddick::Backends.delete_translation k
-        session[:flash_success] = I18n.t('riddick.notice.del.success',
-                                         default: 'Translation successfully deleted!')
+        session[:flash_success] = t('notice.del.success', 'Translation successfully deleted!')
       else
-        session[:flash_error] = I18n.t('riddick.notice.del.error',
-                                       default: 'Error: no such key or key empty!')
+        session[:flash_error] = t('notice.del.error', 'Error: no such key or key empty!')
       end
       redirect(request.referer || root_url)
     end

data/lib/riddick/version.rb

@@ -1,5 +1,5 @@
 module Riddick
   def self.version
-    '0.0.3'
+    '0.0.4'
   end
 end

data/lib/riddick/views/index.erb

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-  <title><%= I18n.t 'riddick.head.title', default: 'Welcome to Riddick!' %></title>
+  <title><%= t 'head.title', 'Welcome to Riddick!' %></title>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <!--[if IE ]><meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1"><![endif]-->
@@ -17,14 +17,14 @@
   <div class="container">
     <div class="navbar">
       <div class="navbar-inner">
-        <a href="<%= root_url %>" class="brand"><%= I18n.t 'riddick.nav.brand', default: 'Riddick' %></a>
+        <a href="<%= root_url %>" class="brand"><%= t 'nav.brand', 'Riddick' %></a>
         <ul class="nav">
           <li class="<%= 'active' if request.path == root_url %>">
-            <a href="<%= root_url %>"><%= I18n.t 'riddick.nav.all', default: 'All translations' %></a></li>
+            <a href="<%= root_url %>"><%= t 'nav.all', 'All translations' %></a></li>
           <li class="<%= 'active' if request.path == my_url %>">
-            <a href="<%= my_url %>"><%= I18n.t 'riddick.nav.my', default: 'My translations' %></a></li>
+            <a href="<%= my_url %>"><%= t 'nav.my', 'My translations' %></a></li>
           <li class="<%= 'active' if request.path == default_url %>">
-            <a href="<%= default_url %>"><%= I18n.t 'riddick.nav.default', default: 'Default translations' %></a></li>
+            <a href="<%= default_url %>"><%= t 'nav.default', 'Default translations' %></a></li>
         </ul>
       </div>
     </div>
@@ -32,15 +32,15 @@
     <!-- Form for posting new and changing existing translations. -->
     <form action="<%= set_url %>" method="post" class="form-horizontal well">
       <select name="k" data-chosen="chosen" data-for="textarea[name=v]"
-          data-placeholder="<%= I18n.t 'riddick.form.select.placeholder', default: 'en.greeting' %>">
+          data-placeholder="<%= t 'form.select.placeholder', 'en.greeting' %>">
         <option></option>
         <% @translations.each do |k, v| %>
-          <option value="<%= k %>" data-v='<%= v %>'><%= k %></option>
+          <option value="<%= h(k) %>" data-v='<%= h(v) %>'><%= h(k) %></option>
         <% end %>
       </select>
-      <button type="submit" class="btn btn-success"><%= I18n.t 'riddick.form.button', default: 'Change' %></button><br />
-      <textarea name="v" type="text"
-          placeholder="<%= I18n.t 'riddick.form.textarea.placeholder', default: 'Hello World!' %>"></textarea>
+      <button type="submit" class="btn btn-success"><%= t 'form.button', 'Change' %></button><br />
+      <textarea name="v" type="text" rows="6"
+          placeholder="<%= t 'form.textarea.placeholder', 'Hello World!' %>"></textarea>
     </form>
 
     <!-- Flash notifications. -->
@@ -54,42 +54,46 @@
     <% if @translations.any? %>
       <table class="table table-striped">
         <tr>
-          <th><%= I18n.t 'riddick.table.header.path', default: 'Path' %></th>
-          <th><%= I18n.t 'riddick.table.header.translation', default: 'Translation' %></th>
-          <th><%= I18n.t 'riddick.table.header.actions', default: 'Actions' %></th>
+          <th><%= t 'table.header.path', 'Path' %></th>
+          <th><%= t 'table.header.translation', 'Translation' %></th>
+          <th><%= t 'table.header.actions', 'Actions' %></th>
         </tr>
         <% @translations.each_pair do |k, v| %>
           <tr>
             <% if v.kind_of? Riddick::Backends::KeyValue::Value %>
               <!-- Details for custom translation. -->
               <td><span class="badge badge-success"><%= k %></span></td>
-              <td><code>
-                  <a rel="popover" data-title="<%= I18n.t 'riddick.table.popover.my', default: 'My translation' %>"
-                    data-content='<%= v %>' data-trigger="hover"><%= truncate v %></a>
-              </code></td>
               <td>
-                <a href="#custom-translations" data-choose="<%= k %>" data-v='<%= v %>'
-                  class="btn btn-mini"><%= I18n.t 'riddick.table.edit.my', default: 'Edit' %></a>
-                <a href="<%= del_url k %>" data-confirm="<%= I18n.t 'riddick.table.confirm', default: 'Are you sure?' %>"
-                  class="btn btn-mini btn-danger"><%= I18n.t 'riddick.table.delete', default: 'Delete' %></a>
+                <code>
+                  <a rel="popover" data-title="<%= t 'table.popover.my', 'My translation' %>"
+                    data-content='<%= h(v) %>' data-trigger="hover"><%= h(truncate(v)) %></a>
+                </code>
+              </td>
+              <td>
+                <a href="#custom-translations" data-choose="<%= h(k) %>" data-v='<%= h(v) %>'
+                  class="btn btn-mini"><%= t 'table.edit.my', 'Edit' %></a>
+                <a href="<%= del_url k %>" data-confirm="<%= t 'table.confirm', 'Are you sure?' %>"
+                  class="btn btn-mini btn-danger"><%= t 'table.delete', 'Delete' %></a>
               </td>
             <% else %>
               <!-- Details for default translation. -->
               <td><span class="badge"><%= k %></span></td>
-              <td><code>
-                <a rel="popover" data-title="<%= I18n.t 'riddick.table.popover.default', default: 'Default translation' %>"
-                  data-content='<%= v %>' data-trigger="hover"><%= truncate v %></a>
-              </code></td>
               <td>
-                <a href="#custom-translations" data-choose="<%= k %>" data-v='<%= v %>'
-                  class="btn btn-mini"><%= I18n.t 'riddick.table.edit.default', default: 'Edit' %></a>
+                <code>
+                  <a rel="popover" data-title="<%= t 'table.popover.default', 'Default translation' %>"
+                    data-content='<%= h(v) %>' data-trigger="hover"><%= h(truncate(v)) %></a>
+                </code>
+              </td>
+              <td>
+                <a href="#custom-translations" data-choose="<%= h(k) %>" data-v='<%= h(v) %>'
+                  class="btn btn-mini"><%= t 'table.edit.default', 'Edit' %></a>
               </td>
             <% end %>
           </tr>
         <% end %>
       </table>
     <% else %>
-      <div class="alert alert-info"><%= I18n.t 'riddick.notice.empty', default: 'You have no translations yet.' %></div>
+      <div class="alert alert-info"><%= t 'notice.empty', 'You have no translations yet.' %></div>
     <% end %>
 
     <div class="well"><a href="https://github.com/kostia/riddick">https://github.com/kostia/riddick</a></div>

data/riddick.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'i18n'
   gem.add_dependency 'redis'
   gem.add_dependency 'sinatra'
+  gem.add_development_dependency 'activesupport', '>= 3.0.0'
   gem.add_development_dependency 'capybara'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rack-test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riddick
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-02 00:00:00.000000000 Z
+date: 2013-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -165,7 +181,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rbenv-version
 - .rspec
 - Gemfile
 - README.md
@@ -191,6 +206,7 @@ files:
 - lib/riddick/version.rb
 - lib/riddick/views/index.erb
 - riddick.gemspec
+- screenshot.png
 - spec/backends/key_value_spec.rb
 - spec/backends/redis_spec.rb
 - spec/backends/simple_spec.rb
@@ -216,9 +232,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4598769758788901426
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Friendly GUI for managing your I18n translations

data/.rbenv-version

@@ -1 +0,0 @@
-1.9.3-p0