inscribe 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99d2808d6732597702d8c63e78b1250c0ba2395c
+  data.tar.gz: caa6213903eaebf80aea0e900d75ef4216212449
+SHA512:
+  metadata.gz: f244f5a3fceb1d75e1aaf11d60d56adddd748486bf912659a88f206e35ea5e1a1d0591624307daadd2d6e48e3084923412a14b0eb9738ea13fe0b6d2b14a1f70
+  data.tar.gz: 819ab4295d951e27961e4d8b420b5a26e310d305497e283f788850675c0748b6c48e5ad20236d46cff96444849217f5d366c2f1e993d41389e4a9864f77f8993

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,34 @@
+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    = 'Inscribe'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

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

@@ -0,0 +1,13 @@
+// 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 vendor/assets/javascripts of plugins, if any, 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/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/inscribe/snippets.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/inscribe/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 vendor/assets/stylesheets of plugins, if any, 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/assets/stylesheets/inscribe/snippets.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/controllers/inscribe/application_controller.rb

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

data/app/controllers/inscribe/snippets_controller.rb

@@ -0,0 +1,62 @@
+require_dependency "inscribe/application_controller"
+
+module Inscribe
+  class SnippetsController < ApplicationController
+    before_action :set_snippet, only: [:show, :edit, :update, :destroy]
+
+    # GET /snippets
+    def index
+      @snippets = Snippet.all
+    end
+
+    # GET /snippets/1
+    def show
+    end
+
+    # GET /snippets/new
+    def new
+      @snippet = Snippet.new
+    end
+
+    # GET /snippets/1/edit
+    def edit
+    end
+
+    # POST /snippets
+    def create
+      @snippet = Snippet.new(snippet_params)
+
+      if @snippet.save
+        redirect_to @snippet, notice: 'Snippet was successfully created.'
+      else
+        render :new
+      end
+    end
+
+    # PATCH/PUT /snippets/1
+    def update
+      if @snippet.update(snippet_params)
+        redirect_to @snippet, notice: 'Snippet was successfully updated.'
+      else
+        render :edit
+      end
+    end
+
+    # DELETE /snippets/1
+    def destroy
+      @snippet.destroy
+      redirect_to snippets_url, notice: 'Snippet was successfully destroyed.'
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_snippet
+        @snippet = Snippet.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def snippet_params
+        params.require(:snippet).permit(:view, :key, :value, :value_type)
+      end
+  end
+end

data/app/helpers/inscribe/application_helper.rb

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

data/app/helpers/inscribe/snippets_helper.rb

@@ -0,0 +1,27 @@
+module Inscribe
+  module SnippetsHelper
+    def snippet(key)
+      snippets_for_current_page[key].to_s.html_safe
+    end
+
+    def load_snippets(views)
+      # The first non-blank data value is returned
+      # Order of snippet value goes: value, value_plain, snippet_image.
+      # --> Now, we just use snippet.snippet_type to determine
+      @snippets_for_current_page ||= begin
+        # Always make sure to grab 'global' snippets too
+        views_list = Array.new().push(views).push('global')
+        Hash[Snippet.where(view: views_list).map{|s| [s.key, format_snippet(s)]}]
+      end
+    end
+
+    def snippets_for_current_page
+      load_snippets("#{controller_name}/#{action_name}")
+    end
+
+    def format_snippet(s)
+      s.
+      s.value
+    end
+  end
+end

data/app/models/inscribe/snippet.rb

@@ -0,0 +1,57 @@
+module Inscribe
+  class Snippet < ActiveRecord::Base
+    enum snippet_type: [:rich_text, :simple_text, :image]
+
+    def self.init(locales: nil, verbose: false)
+      snippets_file_path = File.join(Rails.root, 'db', 'data', 'snippets.yml')
+      puts "Loading snippet defaults from #{snippets_file_path}" if verbose
+      snippets = YAML.load(File.read(snippets_file_path))
+      locales_to_initialize = locales.nil? ? Locale.all : Array.new([locales]).flatten
+      Locale.all.each do |locale|
+        Locale.current_id = locale.id
+        if verbose
+          puts "-" * 40
+          puts "Locale '#{locale.name}'"
+        end
+        snippets.each do |view, snippets_for_view|
+          puts view if verbose
+          failed_snippets = []
+          already_existing_snippets = []
+          created_snippets = []
+          snippets_for_view.each do |key, snippet|
+            existing_snippet = Snippet.find_by(view: view, key: key)
+            if existing_snippet.nil?
+              new_snippet = Snippet.new(view: view, key: key)
+              case snippet['type']
+              when 'rich text'
+                new_snippet.snippet_type = :rich_text
+                new_snippet.value = snippet['value']
+              when 'image'
+                new_snippet.snippet_type = :image
+                new_snippet.save!
+                new_snippet.snippet_image.store!(File.open(File.join(Rails.root, 'db', 'data', 'snippet_files', snippet['value'])))
+                new_snippet.value_plain = ''
+                new_snippet.save
+              else
+                new_snippet.snippet_type = :simple_text
+                new_snippet.value_plain = snippet['value']
+              end
+              if new_snippet.save
+                created_snippets << key
+              else
+                failed_snippets << key
+              end
+            else
+              already_existing_snippets << key
+            end
+          end
+          if verbose
+            puts "  Created #{created_snippets.count}: #{created_snippets.join(', ')}" if created_snippets.any?
+            puts "  Skipped #{already_existing_snippets.count}: #{already_existing_snippets.join(', ')}" if already_existing_snippets.any?
+            puts "  Failed #{failed_snippets.count}: #{failed_snippets.join(', ')}" if failed_snippets.any?
+          end
+        end
+      end
+    end
+  end
+end

data/app/views/inscribe/snippets/_form.html.erb

@@ -0,0 +1,33 @@
+<%= form_for(@snippet) do |f| %>
+  <% if @snippet.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@snippet.errors.count, "error") %> prohibited this snippet from being saved:</h2>
+
+      <ul>
+      <% @snippet.errors.full_messages.each do |message| %>
+        <li><%= message %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :view %><br>
+    <%= f.text_field :view %>
+  </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 :value_type %><br>
+    <%= f.number_field :value_type %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/app/views/inscribe/snippets/edit.html.erb

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

data/app/views/inscribe/snippets/index.html.erb

@@ -0,0 +1,31 @@
+<h1>Listing snippets</h1>
+
+<table>
+  <thead>
+    <tr>
+      <th>View</th>
+      <th>Key</th>
+      <th>Value</th>
+      <th>Value type</th>
+      <th colspan="3"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @snippets.each do |snippet| %>
+      <tr>
+        <td><%= snippet.view %></td>
+        <td><%= snippet.key %></td>
+        <td><%= snippet.value %></td>
+        <td><%= snippet.value_type %></td>
+        <td><%= link_to 'Show', snippet %></td>
+        <td><%= link_to 'Edit', edit_snippet_path(snippet) %></td>
+        <td><%= link_to 'Destroy', snippet, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<br>
+
+<%= link_to 'New Snippet', new_snippet_path %>

data/app/views/inscribe/snippets/new.html.erb

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

data/app/views/inscribe/snippets/show.html.erb

@@ -0,0 +1,24 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <strong>View:</strong>
+  <%= @snippet.view %>
+</p>
+
+<p>
+  <strong>Key:</strong>
+  <%= @snippet.key %>
+</p>
+
+<p>
+  <strong>Value:</strong>
+  <%= @snippet.value %>
+</p>
+
+<p>
+  <strong>Value type:</strong>
+  <%= @snippet.value_type %>
+</p>
+
+<%= link_to 'Edit', edit_snippet_path(@snippet) %> |
+<%= link_to 'Back', snippets_path %>

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

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