RubyGems - riddick - Versions diffs - 0.0.1 - Mend

riddick 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (35) hide show

data/.gitignore +1 -0
data/.rbenv-version +1 -0
data/.rspec +1 -0
data/Gemfile +2 -0
data/README.md +96 -0
data/Rakefile +8 -0
data/lib/riddick.rb +16 -0
data/lib/riddick/backends.rb +30 -0
data/lib/riddick/backends/key_value.rb +11 -0
data/lib/riddick/backends/key_value/value.rb +15 -0
data/lib/riddick/backends/redis.rb +24 -0
data/lib/riddick/backends/redis/value.rb +8 -0
data/lib/riddick/backends/simple.rb +19 -0
data/lib/riddick/hash.rb +25 -0
data/lib/riddick/public/javascripts/riddick.js +22 -0
data/lib/riddick/public/javascripts/vendor/bootstrap.js +7 -0
data/lib/riddick/public/javascripts/vendor/chosen.js +10 -0
data/lib/riddick/public/javascripts/vendor/jquery.js +9266 -0
data/lib/riddick/public/stylesheets/riddick.css +6 -0
data/lib/riddick/public/stylesheets/vendor/bootstrap-responsive.css +9 -0
data/lib/riddick/public/stylesheets/vendor/bootstrap.css +709 -0
data/lib/riddick/public/stylesheets/vendor/chosen-sprite.png +0 -0
data/lib/riddick/public/stylesheets/vendor/chosen.css +384 -0
data/lib/riddick/server.rb +77 -0
data/lib/riddick/version.rb +5 -0
data/lib/riddick/views/index.erb +96 -0
data/riddick.gemspec +27 -0
data/spec/backends/key_value_spec.rb +20 -0
data/spec/backends/redis_spec.rb +61 -0
data/spec/backends/simple_spec.rb +26 -0
data/spec/backends_spec.rb +85 -0
data/spec/hash_spec.rb +14 -0
data/spec/server_spec.rb +133 -0
data/spec/spec_helper.rb +6 -0
metadata +225 -0

data/lib/riddick/version.rb ADDED

@@ -0,0 +1,5 @@
+module Riddick
+  def self.version
+    '0.0.1'
+  end
+end

data/lib/riddick/views/index.erb ADDED

@@ -0,0 +1,96 @@
+<!DOCTYPE html>
+<html lang="en">
+<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]-->
+  <!--[if lt IE 9]>
+  <script src="http://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
+  <![endif]-->
+  <link href="<%= url 'stylesheets/vendor/bootstrap.css' %>" media="all" rel="stylesheet" type="text/css">
+  <link href="<%= url 'stylesheets/vendor/bootstrap-responsive.css' %>" media="all" rel="stylesheet" type="text/css">
+  <link href="<%= url 'stylesheets/vendor/chosen.css' %>" media="all" rel="stylesheet" type="text/css">
+  <link href="<%= url 'stylesheets/riddick.css' %>" media="all" rel="stylesheet" type="text/css">
+</head>
+<body>
+  <div class="container">
+    <div class="navbar">
+      <div class="navbar-inner">
+        <a href="<%= root_url %>" class="brand">Riddick</a>
+        <ul class="nav">
+          <li class="<%= 'active' if request.path == root_url %>">
+            <a href="<%= root_url %>">All translations</a>
+          </li>
+          <li class="<%= 'active' if request.path == my_url %>">
+            <a href="<%= my_url %>">My translations</a>
+          </li>
+          <li class="<%= 'active' if request.path == default_url %>">
+            <a href="<%= default_url %>">Default translations</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+    <form action="<%= set_url %>" method="post" class="form-horizontal well">
+      <select name="k" data-chosen="chosen" data-for="textarea[name=v]" data-placeholder="en.greeting">
+        <option></option>
+        <% @translations.each do |k, v| %>
+          <option value="<%= k %>" data-v='<%= v %>'><%= k %></option>
+        <% end %>
+      </select>
+      <button type="submit" class="btn btn-success">Change</button><br />
+      <textarea name="v" type="text" placeholder="Hello World!"></textarea>
+    </form>
+    <% [:flash_success, :flash_error].each do |k| %>
+      <% if v = session.delete(k) %>
+        <div class="alert alert-<%= k.to_s.gsub 'flash_', '' %>"><%= v %></div>
+      <% end %>
+    <% end %>
+    <% if @translations.any? %>
+      <table class="table table-striped">
+        <tr><th>Path</th><th>Translation</th><th>Actions</th></tr>
+        <% @translations.each_pair do |k, v| %>
+          <tr>
+            <% if v.kind_of? Riddick::Backends::KeyValue::Value %>
+              <td><span class="badge badge-success"><%= k %></span></td>
+              <td><code>
+                <a rel="popover" data-title="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">Edit</a>
+                <a href="<%= del_url k %>" data-confirm="Are you sure?"
+                  class="btn btn-mini btn-danger">Delete</a>
+              </td>
+            <% else %>
+              <td><span class="badge"><%= k %></span></td>
+              <td><code>
+                <a rel="popover" data-title="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">Edit</a>
+              </td>
+            <% end %>
+          </tr>
+        <% end %>
+      </table>
+    <% else %>
+      <div class="alert alert-info">You have no translations yet.</div>
+    <% end %>
+    <div class="well"><a href="https://github.com/kostia/riddick">https://github.com/kostia/riddick</a></div>
+  </div>
+  <script src="<%= url 'javascripts/vendor/jquery.js' %>" type="text/javascript"></script>
+  <script src="<%= url 'javascripts/vendor/chosen.js' %>" type="text/javascript"></script>
+  <script src="<%= url 'javascripts/vendor/bootstrap.js' %>" type="text/javascript"></script>
+  <script src="<%= url 'javascripts/riddick.js' %>" type="text/javascript"></script>
+</body>
+</html>

data/riddick.gemspec ADDED

@@ -0,0 +1,27 @@
+require File.expand_path '../lib/riddick/version', __FILE__
+Gem::Specification.new do |gem|
+  gem.name = 'riddick'
+  gem.version = Riddick.version
+  gem.description = %{
+    Riddick is a simple Sintra based GUI for Redis-I18n-backend.
+    It provides a list of preconfigured translations (via YAML-backend).
+    Also you can add your translations to Redis-backend.
+  }
+  gem.summary = 'Simple GUI for Redis-I18n-backend'
+  gem.homepage = 'https://github.com/kostia/riddick'
+  gem.authors = ['Kostiantyn Kahanskyi']
+  gem.email = %w[kostiantyn.kahanskyi@googlemail.com]
+  gem.files = `git ls-files`.split("\n")
+  gem.require_paths = %w[lib]
+  gem.required_ruby_version = '>= 1.9.3'
+  gem.add_dependency 'i18n'
+  gem.add_dependency 'redis'
+  gem.add_dependency 'sinatra'
+  gem.add_development_dependency 'capybara'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'yajl-ruby'
+end

data/spec/backends/key_value_spec.rb ADDED

@@ -0,0 +1,20 @@
+require 'spec_helper'
+describe Riddick::Backends::KeyValue do
+  describe 'creating a new backend' do
+    it 'should store i18n backend' do
+      i18n_be = mock
+      Riddick::Backends::KeyValue.new(i18n_be).i18n_backend.should == i18n_be
+    end
+  end
+  describe Riddick::Backends::KeyValue::Value do
+    it 'should return decoded string' do
+      v = Riddick::Backends::KeyValue::Value.new MultiJson.encode('foo')
+      v.to_s.should == 'foo'
+      v = Riddick::Backends::KeyValue::Value.new MultiJson.encode(%w[foo bar baz])
+      v.to_s.should == '["foo", "bar", "baz"]'
+    end
+  end
+end

data/spec/backends/redis_spec.rb ADDED

@@ -0,0 +1,61 @@
+require 'spec_helper'
+describe Riddick::Backends::Redis do
+  describe 'creating a new backend' do
+    it 'should be a key value backend' do
+      Riddick::Backends::Redis.new(mock).should be_kind_of(Riddick::Backends::KeyValue)
+    end
+    it 'should store i18n backend' do
+      i18n_be = mock
+      Riddick::Backends::Redis.new(i18n_be).i18n_backend.should == i18n_be
+    end
+  end
+  describe '#translations' do
+    describe 'if there are any keys' do
+      it 'should return the translation hash' do
+        redis_be = mock(store: mock(keys: %w[k1 k2 k3]))
+        redis_be.store.should_receive(:mget).with(%w[k1 k2 k3]).and_return %w["v1" "v2" "v3"]
+        translations = Riddick::Backends::Redis.new(redis_be).translations
+        translations.size.should == 3
+        translations['k1'].should be_a(Riddick::Backends::Redis::Value)
+        translations['k1'].to_s.should == 'v1'
+        translations['k2'].should be_a(Riddick::Backends::Redis::Value)
+        translations['k2'].to_s.should == 'v2'
+        translations['k3'].should be_a(Riddick::Backends::Redis::Value)
+        translations['k3'].to_s.should == 'v3'
+      end
+    end
+    describe 'if there are no keys' do
+      it 'should return an empty hash' do
+        redis_be = mock(store: mock(keys: []))
+        Riddick::Backends::Redis.new(redis_be).translations.should == {}
+      end
+    end
+  end
+  describe '#delete_translation' do
+    it 'should delete key from the store' do
+      redis_be = mock store: mock
+      redis_be.store.should_receive(:del).with 'foo.bar'
+      Riddick::Backends::Redis.new(redis_be).delete_translation 'foo.bar'
+    end
+  end
+  describe Riddick::Backends::Redis::Value do
+    it 'should be a general key value value' do
+      v = Riddick::Backends::Redis::Value.new '"foo"'
+      v.should be_kind_of(Riddick::Backends::KeyValue::Value)
+    end
+    it 'should return decoded string' do
+      v = Riddick::Backends::Redis::Value.new MultiJson.encode('foo')
+      v.to_s.should == 'foo'
+      v = Riddick::Backends::Redis::Value.new MultiJson.encode(%w[foo bar baz])
+      v.to_s.should == '["foo", "bar", "baz"]'
+    end
+  end
+end

data/spec/backends/simple_spec.rb ADDED

@@ -0,0 +1,26 @@
+require 'spec_helper'
+describe Riddick::Backends::Simple do
+  describe 'creating a new backend' do
+    it 'should store i18n backend' do
+      i18n_be = mock
+      Riddick::Backends::Simple.new(i18n_be).i18n_backend.should == i18n_be
+    end
+  end
+  describe '#translations' do
+    it 'should return normalized translation from i18n backend' do
+      I18n.stub(:locale).and_return :en
+      i18n_be = mock translations: {en: {'foo' => {'bar' => 'baz'}}}
+      Riddick::Backends::Simple.new(i18n_be).translations.should == {'en.foo.bar' => 'baz'}
+    end
+  end
+  describe '#init_translations' do
+    it 'should init translations of i18n backend' do
+      i18n_be = mock
+      i18n_be.should_receive :init_translations
+      Riddick::Backends::Simple.new(i18n_be).init_translations
+    end
+  end
+end

data/spec/backends_spec.rb ADDED

@@ -0,0 +1,85 @@
+require 'spec_helper'
+describe Riddick::Backends do
+  describe '#chain' do
+    context 'when not set via setter method' do
+      it 'should return I18n backend chain' do
+        Riddick::Backends.chain.should == I18n.backend
+      end
+    end
+    context 'when set via setter method' do
+      it 'should return the chain object' do
+        chain = mock
+        Riddick::Backends.chain = chain
+        Riddick::Backends.chain.should == chain
+      end
+    end
+  end
+  describe '#simple' do
+    let(:kv_be) { I18n::Backend::KeyValue.new({}) }
+    let(:s_be) { I18n::Backend::Simple.new }
+    let(:chain) { mock backends: [kv_be, s_be] }
+    before do
+      Riddick::Backends.chain = chain
+    end
+    context 'when no set via setter method' do
+      it 'should determine backend dynamically' do
+        Riddick::Backends.simple.should be_kind_of(Riddick::Backends::Simple)
+        Riddick::Backends.simple.i18n_backend.should == s_be
+      end
+    end
+    context 'when set via setter method' do
+      it 'should return the backend object' do
+        Riddick::Backends.simple = s_be
+        Riddick::Backends.simple.should == s_be
+      end
+    end
+  end
+  describe '#key_value' do
+    let(:kv_be) { I18n::Backend::KeyValue.new({}) }
+    let(:s_be) { I18n::Backend::Simple.new }
+    let(:chain) { mock backends: [kv_be, s_be] }
+    before do
+      Riddick::Backends.chain = chain
+    end
+    context 'when no set via setter method' do
+      it 'should determine backend dynamically' do
+        Riddick::Backends.key_value.should be_kind_of(Riddick::Backends::Redis)
+        Riddick::Backends.key_value.i18n_backend.should == kv_be
+      end
+    end
+    context 'when set via setter method' do
+      it 'should return the backend object' do
+        Riddick::Backends.key_value = kv_be
+        Riddick::Backends.key_value.should == kv_be
+      end
+    end
+  end
+  describe '#store_translation' do
+    it 'should store unescaped translation in chain with correctly determined path' do
+      chain = mock
+      Riddick::Backends.chain = chain
+      chain.should_receive(:store_translations).with 'en', {'foo.bar' => 'baz'}, {escape: false}
+      Riddick::Backends.store_translation 'en.foo.bar', 'baz'
+    end
+  end
+  describe '#delete_translation' do
+    it 'should delete translation from key value backend' do
+      kv_be = mock
+      Riddick::Backends.key_value = kv_be
+      kv_be.should_receive(:delete_translation).with 'foo.bar'
+      Riddick::Backends.delete_translation 'foo.bar'
+    end
+  end
+end

data/spec/hash_spec.rb ADDED

@@ -0,0 +1,14 @@
+require 'spec_helper'
+describe Hash do
+  describe '#riddick_normalize_i18n' do
+    it 'should return i18n-style hash' do
+      {
+        foo: {
+          bar: 'baz',
+          blub: 'bla',
+        }
+      }.riddick_normalize_i18n('en').should == {'en.foo.bar' => 'baz', 'en.foo.blub' => 'bla'}
+    end
+  end
+end

data/spec/server_spec.rb ADDED

@@ -0,0 +1,133 @@
+require 'capybara/rspec'
+require 'rack/test'
+require 'spec_helper'
+set :environment, :test
+describe 'Riddick::Server', type: :request do
+  include Rack::Test::Methods
+  def app
+    Riddick::Server.new
+  end
+  let(:s_be) { mock }
+  let(:kv_be) { mock }
+  before do
+    Riddick::Backends.simple = s_be
+    Riddick::Backends.key_value = kv_be
+    s_be.should_receive :init_translations # Assert translations are initialized on load
+    load 'lib/riddick/server.rb'
+    s_be.stub(:translations).and_return({
+      'en.k1' => 'default-v1',
+      'en.k2' => 'default-v2',
+    })
+    kv_be.stub(:translations).and_return({
+      'en.k2' => Riddick::Backends::Redis::Value.new('"my-v2"'),
+      'en.k3' => Riddick::Backends::Redis::Value.new('"my-v3"'),
+    })
+  end
+  describe 'GET /' do
+    it 'should render list of all translations overlaying default with my' do
+      get '/'
+      last_response.should be_ok
+      last_response.body.should have_selector("option[value='en.k1'][data-v='default-v1']")
+      last_response.body.should have_selector("option[value='en.k2'][data-v='my-v2']")
+      last_response.body.should have_selector("option[value='en.k3'][data-v='my-v3']")
+    end
+  end
+  describe 'GET /my' do
+    it 'should render list of my translations' do
+      get '/my'
+      last_response.should be_ok
+      last_response.body.should_not have_selector("option[data-v^='default-']")
+      last_response.body.should have_selector("option[value='en.k2'][data-v='my-v2']")
+      last_response.body.should have_selector("option[value='en.k3'][data-v='my-v3']")
+    end
+  end
+  describe 'GET /default' do
+    it 'should render list of default translations' do
+      get '/default'
+      last_response.should be_ok
+      last_response.body.should_not have_selector("option[data-v^='my-']")
+      last_response.body.should have_selector("option[value='en.k1'][data-v='default-v1']")
+      last_response.body.should have_selector("option[value='en.k2'][data-v='default-v2']")
+    end
+  end
+  describe 'POST /set' do
+    context 'with valid params' do
+      it 'should store translation and redirect to my translation' do
+        Riddick::Backends.should_receive(:store_translation).with 'en.k1', 'my-v1' do
+          kv_be.stub(:translations).and_return({
+            'en.k1' => Riddick::Backends::Redis::Value.new('"my-v1"'),
+            'en.k2' => Riddick::Backends::Redis::Value.new('"my-v2"'),
+            'en.k3' => Riddick::Backends::Redis::Value.new('"my-v3"'),
+          })
+        end
+        post '/set', k: 'en.k1', v: 'my-v1'
+        follow_redirect!
+        last_response.should be_ok
+        last_response.body.should_not have_selector("option[data-v^='default-']")
+        last_response.body.should have_selector("option[value='en.k1'][data-v='my-v1']")
+        last_response.body.should have_selector("option[value='en.k2'][data-v='my-v2']")
+        last_response.body.should have_selector("option[value='en.k3'][data-v='my-v3']")
+      end
+    end
+    context 'with incorrect params' do
+      it 'should not try to store translation and render index' do
+        Riddick::Backends.should_not_receive :store_translation
+        post '/set', k: 'en.k1', v: ''
+        follow_redirect!
+        last_response.should be_ok
+        last_response.body.should have_selector("option[value='en.k2'][data-v='my-v2']")
+        last_response.body.should have_selector("option[value='en.k3'][data-v='my-v3']")
+        post '/set', k: '', v: 'my-v1'
+        follow_redirect!
+        last_response.should be_ok
+        last_response.body.should have_selector("option[value='en.k2'][data-v='my-v2']")
+        last_response.body.should have_selector("option[value='en.k3'][data-v='my-v3']")
+      end
+    end
+  end
+  describe 'GET /del' do
+    context 'with valid key' do
+      it 'should delete translation and redirect root' do
+        Riddick::Backends.should_receive(:delete_translation).with 'en.k2' do
+          kv_be.stub(:translations).and_return({
+            'en.k3' => Riddick::Backends::Redis::Value.new('"my-v3"'),
+          })
+        end
+        get '/del', k: 'en.k2'
+        follow_redirect!
+        last_response.should be_ok
+        last_response.body.should have_selector("option[value='en.k1'][data-v='default-v1']")
+        last_response.body.should have_selector("option[value='en.k2'][data-v='default-v2']")
+        last_response.body.should have_selector("option[value='en.k3'][data-v='my-v3']")
+      end
+    end
+    context 'with invalid key' do
+      it 'should delete translation and redirect root' do
+        Riddick::Backends.should_not_receive :delete_translation
+        get '/del', k: ''
+        follow_redirect!
+        last_response.should be_ok
+        last_response.body.should have_selector("option[value='en.k1'][data-v='default-v1']")
+        last_response.body.should have_selector("option[value='en.k2'][data-v='my-v2']")
+        last_response.body.should have_selector("option[value='en.k3'][data-v='my-v3']")
+      end
+    end
+  end
+end