txtblx 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33f2917fbd7f77fa2bcda630ce92bbb4505633ff
+  data.tar.gz: 4bebfa38134daa57ca32a98441d96ff983920888
+SHA512:
+  metadata.gz: f397e5d7da4a75b36127d8b2fb3818a983bb65218de7478dd202f33c4ea9e4fb0fb1516de5c7a6f3d085202eb3b25473d6f747a791a9ea00936e743ed144574e
+  data.tar.gz: f0967e9be2405f8072424eef2a63a6b18170552c25c23c37ffc34111b625257b668557521dedac6d90552f73ae8d5d102206079c3383e6e7ee6c4c5113f2d8ff

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Vangelis Tsoumenis
+
+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.md

@@ -0,0 +1,63 @@
+# Textblocks
+
+## Editable, revisioned front-end texts for rails apps.
+
+Txtblx provides a simple way to allow Active Admin users to edit interface copy.
+
+## Installation
+
+### Add `txtblx` to you Gemfile
+
+    gem 'txtblx'
+
+### Migrate your database:
+
+    bundle exec rake txtblx:install:migrations
+    bundle exec rake db:migrate
+
+### Load helpers in your application controller:
+
+    helper(Txtblx::Engine.helpers)
+
+### Use in Templates
+
+    <h1>Welcome<h1>
+
+    <%= txt('homepage.welcome') %>
+
+
+## Active Admin Integration
+
+Txtblx comes with an ActiveAdmin page to manage Textblocks
+
+
+### CanCan Integration
+
+Txtblx provides default CanCan Abilities for its model.
+Use the AbilityMixin to grant them to your user model inside your Ability-class.
+
+    # app/models/ability.rb
+    class Ability
+      include CanCan::Ability
+      include Txtblx::AbilityMixin
+
+      def initialize(user)
+        txtblx_abilities(user)
+      end
+    end
+
+# Configuration
+
+Txtblx uses [`auto_html`](https://github.com/dejan/auto_html) to convert text to HTML.
+To change the `auto_html` config create an initializer in your app:
+
+    # config/initializers/txtblx.rb
+    Txtblx.configure do |config|
+      config.auto_html_block = Proc.new do
+        # you config here, for example:
+        html_escape
+        image
+        link(:target => "_blank", :rel => "nofollow")
+        simple_format
+      end
+    end

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'Txtblx'
+  rdoc.options << '--line-numbers'
+  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/txtblx/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 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_tree .

data/app/assets/stylesheets/txtblx/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/txtblx/application_controller.rb

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

data/app/helpers/txtblx/application_helper.rb

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

data/app/helpers/txtblx/textblocks_helper.rb

@@ -0,0 +1,14 @@
+module Txtblx
+  module TextblocksHelper
+    def txt(key)
+      textblock = Textblock.by_key(key)
+      if textblock.present?
+         text = textblock.text_html
+      else
+         text =  I18n.t('txtblx.missing_key', key: key)
+      end
+
+      content_tag(:div, text)
+    end
+  end
+end

data/app/models/txtblx/textblock.rb

@@ -0,0 +1,24 @@
+module Txtblx
+  class Textblock < ActiveRecord::Base
+    include Snaps.revision(default_tag: :draft)
+
+    scope :published, -> { with_snaps_tag(:published) }
+    scope :drafts, -> { with_snaps_tag(:draft) }
+
+    def publish
+      snapshot!(tag: :published)
+    end
+
+    auto_html_for :text do
+      self.instance_eval(&Txtblx.config.auto_html_block)
+    end
+
+    def to_param
+      perma_id.to_s
+    end
+
+    def self.by_key(key)
+      Textblock.published.find_by_key(key)
+    end
+  end
+end

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

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

data/config/locales/activerecord.de.yml

@@ -0,0 +1,12 @@
+de:
+  activerecord:
+    models:
+      textblock:
+        one: "Textblock"
+        other: "Textblöcke"
+    attributes:
+      textblock:
+        key: "Schlüssel"
+        description: "Beschreibung"
+        text: "Text"
+        text_html: "HTML"

data/config/locales/txtblx.de.yml

@@ -0,0 +1,3 @@
+de:
+  txtblx:
+    missing_key: "Textblock mit dem Schlüssel `%{key}` fehlt."

data/config/locales/txtblx.en.yml

@@ -0,0 +1,3 @@
+en:
+  txtblx:
+    missing_key: "Textblock with key `%{key}` not found."

data/config/routes.rb

@@ -0,0 +1,2 @@
+Txtblx::Engine.routes.draw do
+end

data/db/migrate/20150405222157_create_txtblx_textblocks.rb

@@ -0,0 +1,14 @@
+class CreateTxtblxTextblocks < ActiveRecord::Migration
+  def change
+    create_table :txtblx_textblocks do |t|
+      t.integer :perma_id
+      t.string :key
+      t.string :description
+      t.text :text
+      t.text :text_html
+      t.string :path
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/tasks/txtblx_tasks.rake

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

data/lib/txtblx/ability_mixin.rb

@@ -0,0 +1,11 @@
+module Txtblx
+  module AbilityMixin
+    # Call this in the ability initializer of the host app
+    def txtblx_abilities(user)
+      return if user.nil?
+
+      can(:manage, Textblock)
+    end
+  end
+end
+

data/lib/txtblx/admin/textblocks.rb

@@ -0,0 +1,59 @@
+module Txtblx
+  if defined?(ActiveAdmin)
+    ActiveAdmin.register Textblock, as: 'Textblock' do
+      actions :all, except: [:destroy]
+
+      index do
+        column :key do |textblock|
+          link_to(textblock.key, admin_textblock_path(textblock))
+        end
+        column :description
+      end
+
+      show do |textblock|
+        div :class => :columns do
+          attributes_table_for textblock do
+            row :key
+            row :description
+            row :text
+          end
+        end
+      end
+
+      form do |f|
+        f.inputs :key, :description, :text
+        f.actions do
+          f.action :submit
+          f.action :cancel, as: :link, button_html: {class: 'button'}
+        end
+      end
+
+      controller do
+        def permitted_params
+          params.permit(:utf8, :_method, :authenticity_token, :commit, :id,
+            textblock: [:key, :perma_id, :description, :text])
+        end
+
+        def update
+          result = super
+          resource.publish if resource.valid?
+          result
+        end
+
+        def create
+          result = super
+          resource.publish if resource.valid?
+          result
+        end
+
+        def find_resource
+          Textblock.drafts.where(perma_id: params[:id]).first!
+        end
+
+        def scoped_collection
+          Textblock.drafts
+        end
+      end
+    end
+  end
+end

data/lib/txtblx/configuration.rb

@@ -0,0 +1,13 @@
+module Txtblx
+  class Configuration
+    attr_accessor :auto_html_block
+
+    def initialize
+      @auto_html_block = Proc.new do
+        html_escape
+        link :target => "_blank", :rel => "nofollow"
+        simple_format
+      end
+    end
+  end
+end

data/lib/txtblx/engine.rb

@@ -0,0 +1,16 @@
+module Txtblx
+  class Engine < ::Rails::Engine
+    isolate_namespace Txtblx
+
+    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
+
+    initializer :txtblx_admin do
+      ActiveAdmin.application.load_paths.unshift File.join(config.root, 'lib/txtblx/admin')
+    end
+  end
+end

data/lib/txtblx/version.rb

@@ -0,0 +1,3 @@
+module Txtblx
+  VERSION = "0.0.1"
+end

data/lib/txtblx.rb

@@ -0,0 +1,13 @@
+require 'txtblx/engine'
+require 'txtblx/ability_mixin'
+require 'txtblx/configuration'
+
+module Txtblx
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/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 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_tree .

data/spec/dummy/app/assets/stylesheets/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/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,8 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+
+
+  helper(Txtblx::Engine.helpers)
+end

data/spec/dummy/app/controllers/dummies_controller.rb

@@ -0,0 +1,5 @@
+class DummiesController < ApplicationController
+  def index
+  end
+end
+

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/dummies/index.html.erb

@@ -0,0 +1,3 @@
+ <h1>The Dummy App</h1>
+
+ <%= txt('homepage.welcome') %>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "txtblx"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!