champollion 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ebbcfd645ca35bd4e73e1d1766ff5dfecc0dc0b
+  data.tar.gz: acb3be8233db305fcf643c6bec654f6565edee92
+SHA512:
+  metadata.gz: 2180a468f62df7bd00c0637783d28256e7a18778ca14030027f2d17898619f7c136233332d4af6c5f211acea0a5b0d602dbb309986a25cf9f8fa9c066eb9680f
+  data.tar.gz: e080ccc9da6294d779c04946013e932c503a9b5167faf38e5597bd6832f6ba8467f2a4273c1a9f036901070e8e336f6a895d41c1fc96bac218245dbed3a0a4b6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Razvan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,3 @@
+= Champollion
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Champollion'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/assets/javascripts/champollion/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/champollion/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/champollion/application_controller.rb

@@ -0,0 +1,4 @@
+module Champollion
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/champollion/translations_controller.rb

@@ -0,0 +1,65 @@
+require_dependency "champollion/application_controller"
+
+module Champollion
+  class TranslationsController < ApplicationController
+    before_action :set_translation, only: [:show, :edit, :update, :destroy]
+
+    # GET /translations
+    def index
+      respond_to do |format|
+        format.html { @translations = Translation.all }
+        format.json { render json: Translation.all_translations.to_json }
+      end
+    end
+
+    # GET /translations/1
+    def show
+    end
+
+    # GET /translations/new
+    def new
+      @translation = Translation.new
+    end
+
+    # GET /translations/1/edit
+    def edit
+    end
+
+    # POST /translations
+    def create
+      @translation = Translation.new(translation_params)
+
+      if @translation.save
+        redirect_to @translation, notice: 'Translation was successfully created.'
+      else
+        render :new
+      end
+    end
+
+    # PATCH/PUT /translations/1
+    def update
+      if @translation.update(translation_params)
+        redirect_to @translation, notice: 'Translation was successfully updated.'
+      else
+        render :edit
+      end
+    end
+
+    # DELETE /translations/1
+    def destroy
+      @translation.destroy
+      redirect_to translations_url, notice: 'Translation was successfully destroyed.'
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_translation
+        @translation = Translation.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def translation_params
+        params.require(:translation).permit(:locale, :key, :value, :interpolations, :is_proc)
+      end
+  end
+end

data/app/helpers/champollion/application_helper.rb

@@ -0,0 +1,4 @@
+module Champollion
+  module ApplicationHelper
+  end
+end

data/app/models/champollion/translation.rb

@@ -0,0 +1,27 @@
+module Champollion
+  class Translation < ActiveRecord::Base
+    self.table_name = "translations"
+
+    has_paper_trail
+
+    validates :locale, presence: true
+    validates :key, presence: true
+    validates :value, presence: true
+
+    def self.all_translations
+      # create empty hash for locales
+      translation_hash = Hash.new { |k,v| k[v] = {} }
+
+      # iterate through the translation records
+      all.each do |translation|
+        # get the key components
+        key_scopes = translation.key.split(".")
+
+        translation_hash[translation.locale.to_sym] ||= {}
+        translation_hash[translation.locale.to_sym].merge!(key_scopes.reverse.inject(translation.value) {|a,n| { n.to_sym => a}})
+      end
+
+      translation_hash 
+    end
+  end
+end

data/app/views/champollion/translations/_form.html.erb

@@ -0,0 +1,38 @@
+<%= form_for(@translation) do |f| %>
+  <% if @translation.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@translation.errors.count, "error") %> prohibited this translation from being saved:</h2>
+
+      <ul>
+      <% @translation.errors.full_messages.each do |message| %>
+        <li><%= message %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :locale %><br>
+    <%= f.text_field :locale %>
+  </div>
+  <div class="field">
+    <%= f.label :key %><br>
+    <%= f.text_field :key %>
+  </div>
+  <div class="field">
+    <%= f.label :value %><br>
+    <%= f.text_area :value %>
+  </div>
+  <div class="field">
+    <%= f.label :interpolations %><br>
+    <%= f.text_field :interpolations %>
+  </div>
+  <div class="field">
+    <%= f.label :is_proc %><br>
+    <%= f.check_box :is_proc %>
+  </div>
+
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/app/views/champollion/translations/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing Translation</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Show', @tranlation %> |
+<%= link_to 'Back', translations_path %>

data/app/views/champollion/translations/index.html.erb

@@ -0,0 +1,31 @@
+<p id="notice"><%= notice %></p>
+
+<h1>Listing Translations</h1>
+
+<table>
+  <thead>
+    <tr>
+      <th>Locale</th>
+      <th>Key</th>
+      <th>Value</th>
+      <th colspan="3"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @translations.each do |translation| %>
+      <tr>
+        <td><%= translation.locale %></td>
+        <td><%= translation.key %></td>
+        <td><%= translation.value %></td>
+        <td><%= link_to 'Show', translation %></td>
+        <td><%= link_to 'Edit', edit_translation_path(translation) %></td>
+        <td><%= link_to 'Destroy', translation, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<br>
+
+<%= link_to 'New Translation', new_translation_path %>

data/app/views/champollion/translations/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New Translation</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', translations_path %>

data/app/views/champollion/translations/show.html.erb

@@ -0,0 +1,28 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <strong>Locale:</strong>
+  <%= @translation.locale %>
+</p>
+
+<p>
+  <strong>Key:</strong>
+  <%= @translation.key %>
+</p>
+
+<p>
+  <strong>Value:</strong>
+  <%= @translation.value %>
+</p>
+
+<p>
+  <h2>Versions</h2>
+  <ul>
+    <% @translation.versions.each do |version| %>
+      <li><%= version.event %> | <%= version.index %> @ <%= version.created_at %></li>
+    <% end %>
+  </ul>
+</p>
+
+<%= link_to 'Edit', edit_translation_path(@translation) %> |
+<%= link_to 'Back', translations_path %>

data/app/views/layouts/champollion/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Champollion</title>
+  <%= stylesheet_link_tag    "champollion/application", media: "all" %>
+  <%= javascript_include_tag "champollion/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/locale.rb

@@ -0,0 +1,4 @@
+require "i18n/backend/active_record"
+
+I18n.backend = I18n::Backend::ActiveRecord.new
+I18n.config.enforce_available_locales = false

data/config/routes.rb

@@ -0,0 +1,5 @@
+Champollion::Engine.routes.draw do
+  resources :translations
+
+  root 'translations#index'
+end

data/db/migrate/20150417194342_create_translations.rb

@@ -0,0 +1,13 @@
+class CreateTranslations < ActiveRecord::Migration
+  def change
+    create_table :translations do |t|
+      t.string :locale
+      t.string :key
+      t.text :value
+      t.text :interpolations
+      t.boolean :is_proc, default: false
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20150504193440_create_versions.rb

@@ -0,0 +1,13 @@
+class CreateVersions < ActiveRecord::Migration
+  def change
+    create_table :versions do |t|
+      t.string   :item_type, :null => false
+      t.integer  :item_id,   :null => false
+      t.string   :event,     :null => false
+      t.string   :whodunnit
+      t.text     :object
+      t.datetime :created_at
+    end
+    add_index :versions, [:item_type, :item_id]
+  end
+end

data/lib/champollion.rb

@@ -0,0 +1,4 @@
+require "champollion/engine"
+
+module Champollion
+end

data/lib/champollion/engine.rb

@@ -0,0 +1,15 @@
+require "paper_trail"
+
+module Champollion
+  class Engine < ::Rails::Engine
+    isolate_namespace Champollion
+    
+    config.generators do |g|
+      g.test_framework      :rspec,        :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+
+  end
+end

data/lib/champollion/version.rb

@@ -0,0 +1,3 @@
+module Champollion
+  VERSION = "0.1.0"
+end

data/lib/tasks/champollion_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :champollion do
+#   # Task goes here
+# end

data/spec/controllers/champollion/translations_controller_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+
+module Champollion
+  RSpec.describe TranslationsController, :type => :controller do
+    routes { Champollion::Engine.routes }
+
+    let(:valid_attributes) {
+      {
+        locale: :en,
+        key: 'home.button',
+        value: 'Hello'
+      }
+    }
+
+    let(:invalid_attributes) {
+      {
+        locale: :en
+      }
+    }
+
+    describe "GET index" do
+      it "assigns all translations as @translations" do
+        translation = Translation.create! valid_attributes
+        get :index
+        expect(assigns(:translations)).to eq([translation])
+      end
+
+      it "returns json array when format is json" do
+        Translation.create! valid_attributes
+
+        get :index, format: :json
+        expect(response).to be_success
+
+        body = JSON.parse(response.body)
+        expect(body).to include("en")
+        expect(body).to eq({"en" => {"home" => {"button" => "Hello"}}})
+      end
+    end
+
+    describe "GET show" do
+      it "assigns the requested translation as @translation" do
+        translation = Translation.create! valid_attributes
+        get :show, {:id => translation.to_param}
+        expect(assigns(:translation)).to eq(translation)
+      end
+    end
+
+    describe "GET new" do
+      it "assigns a new translation as @translation" do
+        get :new
+        expect(assigns(:translation)).to be_a_new(Translation)
+      end
+    end
+
+    describe "GET edit" do
+      it "assigns the requested translation as @translation" do
+        translation = Translation.create! valid_attributes
+        get :edit, {:id => translation.to_param}
+        expect(assigns(:translation)).to eq(translation)
+      end
+    end
+
+    describe "POST create" do
+      describe "with valid params" do
+        it "creates a new Translation" do
+          expect {
+            post :create, {:translation => valid_attributes}
+          }.to change(Translation, :count).by(1)
+        end
+
+        it "assigns a newly created translation as @translation" do
+          post :create, {:translation => valid_attributes}
+          expect(assigns(:translation)).to be_a(Translation)
+          expect(assigns(:translation)).to be_persisted
+        end
+
+        it "redirects to the created translation" do
+          post :create, {:translation => valid_attributes}
+          expect(response).to redirect_to(Translation.last)
+        end
+      end
+
+      describe "with invalid params" do
+        it "assigns a newly created but unsaved translation as @translation" do
+          post :create, {:translation => invalid_attributes}
+          expect(assigns(:translation)).to be_a_new(Translation)
+        end
+
+      end
+    end
+
+    describe "PUT update" do
+      describe "with valid params" do
+        let(:new_attributes) {
+          {
+            locale: :en,
+            key: 'home.button',
+            value: 'New value'
+          }
+        }
+
+        it "updates the requested translation" do
+          translation = Translation.create! valid_attributes
+          put :update, {:id => translation.to_param, :translation => new_attributes}
+          translation.reload
+          expect(translation.value).to eq("New value")
+        end
+
+        it "assigns the requested translation as @translation" do
+          translation = Translation.create! valid_attributes
+          put :update, {:id => translation.to_param, :translation => valid_attributes}
+          expect(assigns(:translation)).to eq(translation)
+        end
+
+        it "redirects to the translation" do
+          translation = Translation.create! valid_attributes
+          put :update, {:id => translation.to_param, :translation => valid_attributes}
+          expect(response).to redirect_to(translation)
+        end
+      end
+
+      describe "with invalid params" do
+        it "assigns the translation as @translation" do
+          translation = Translation.create! valid_attributes
+          put :update, {:id => translation.to_param, :translation => invalid_attributes}
+          expect(assigns(:translation)).to eq(translation)
+        end
+
+        it "re-renders the 'edit' translation" do
+          translation = Translation.create! valid_attributes
+          put :update, {:id => translation.to_param, :translation => invalid_attributes}
+          expect(response).to redirect_to(translation)
+        end
+      end
+    end
+
+    describe "DELETE destroy" do
+      it "destroys the requested translation" do
+        translation = Translation.create! valid_attributes
+        expect {
+          delete :destroy, {:id => translation.to_param}
+        }.to change(Translation, :count).by(-1)
+      end
+
+      it "redirects to the translations list" do
+        translation = Translation.create! valid_attributes
+        delete :destroy, {:id => translation.to_param}
+        expect(response).to redirect_to(translations_url)
+      end
+    end
+
+  end
+end