revelry_content 0.0.1.1 → 0.0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bef437f3c11d55256e157563635ffc4310b268c1
-  data.tar.gz: 53f2dd0abaf1fe847a88b7647b6530b9bbf858ec
+  metadata.gz: d57f008f016c584fc60768a5c49a53ebdb5ba404
+  data.tar.gz: ff49d78be60b93f65f80bddad50fd5d3831349fe
 SHA512:
-  metadata.gz: 79e9d46095a0c15a7d0d919180da3fb20d2f400e065c0e9faf86fa4c87d32ff14a9dcadb686182cf7960badba8676d4260d2c83443a018da268d2233165953d0
-  data.tar.gz: fe731925368b398e67ee3822d51ea4f0907bddb7117197335777321980a1bda58e4656e1b844770f9d0f0090daa958d3eb3b43a23a6108c6f532bdcec332482d
+  metadata.gz: e61ebb2af92ac13c2054557738082162d8e1066b43f81e32d63a6566955de141b3ed86cf79f7b8e07559d202f26bc2d9d33af901c50d25b534a949490eeb8014
+  data.tar.gz: 21387b6aaf8c2c34d83585636742bc8fab9991f8447d715357c5d02b64b6800638c0a8b67a25180feed669d2d2360f9d98ae1643309205a866dad6d24a782647

data/README.md

@@ -5,71 +5,29 @@ RevelryContent is a gem for managing admin-editable content within Rails applica
 
 # Installation
 
-Add it to your gemfile.
+Either install from a rails template:
 
-Then run:
-
-```bash
-bundle install
-rails g revelry_content:install
-rake db:migrate
+```shell
+rails new APPNAME -m https://raw.githubusercontent.com/revelrylabs/revelry_content/master/template.rb
 ```
 
-Mount the engine in your routes.rb file:
+Or add it to your gemfile:
 
 ```ruby
-mount RevelryContent::Engine => "/revelry_content"
+gem 'revelry_content'
 ```
 
-Include RevelryContent::WithRevelryContent in any controllers which need to show editable
-content. You probably want to include it in ApplicationController like so:
-
-```ruby
-class ApplicationController
-  include RevelryContent::WithRevelryContent
-  def index; end
-end
-```
+and install it:
 
-And include the editor javascript:
-```javascript
-//= require revelry_content
-```
-
-Add include the editor stylesheet:
-```css
-/*
-*= require revelry_content/application
-*/
+```shell
+bundle
+rails g revelry_content:install
 ```
 
-
 # Configuration
 
-## Configuring authentication
-
-```ruby
-RevelryContent.configure do |config|
-  config.user_for_content do |controller|
-    # Your authentication logic here
-    controller.current_user
-  end
-end
-```
-
-## Configuring authorization
-
-You can set a block which takes two params `user` and `content` to handle authorization.
-True is authorized, false is unauthorized.
-
-```ruby
-RevelryContent.configure do |config|
-  config.authorization_policy do |user|
-    # Your authorization logic here
-    user.admin?
-  end
-end
-```
+The installer makes an initializer in `config/initializer.rb`. You can edit it
+to customize authenticiation, authorization or javascript export settings.
 
 ## Configuring file uploads
 

data/lib/generators/revelry_content/css_generator.rb

@@ -0,0 +1,47 @@
+module RevelryContent
+  module Generators
+    class CssGenerator < ::Rails::Generators::Base
+      CSS_FILE_EXTENSIONS = %w(
+        .css
+        .css.sass
+        .css.scss
+        .sass
+        .scss
+      )
+
+      def add_css_assets
+        if using_sass?
+          append_to_file css_app_bundle do
+            '@import "revelry_content";'
+          end
+        else
+          insert_into_file css_app_bundle, before: %r{(//|\*)= require_self} do
+            "*= require revelry_content\n "
+          end
+        end
+      end
+
+      private
+
+      def using_sass?
+        /s(c|a)ss/.match(css_file_extname)
+      end
+
+      def css_app_bundle
+        File.join(css_base_dir, "application#{ css_file_extname }")
+      end
+
+      def css_base_dir
+        File.join('app', 'assets', 'stylesheets')
+      end
+
+      def test_css_format(fmt)
+        File.exist?(File.join(css_base_dir, "application#{ fmt }"))
+      end
+
+      def css_file_extname
+        CSS_FILE_EXTENSIONS.find { |fmt| test_css_format(fmt) }
+      end
+    end
+  end
+end

data/lib/generators/revelry_content/initializer_generator.rb

@@ -0,0 +1,11 @@
+module RevelryContent
+  module Generators
+    class InitializerGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def add_initializer
+        template 'initializer.rb', 'config/initializers/revelry_content.rb'
+      end
+    end
+  end
+end

data/lib/generators/revelry_content/install_generator.rb

@@ -1,24 +1,37 @@
-require 'rails/generators/migration'
-
 module RevelryContent
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
-      include Rails::Generators::Migration
-      source_root File.expand_path('../templates', __FILE__)
-      desc "add the migrations"
+      def add_migrations
+        generate 'revelry_content:migrations'
+        rake 'db:migrate'
+      end
+
+      def add_js_assets
+        generate 'revelry_content:js'
+      end
+
+      def add_css_assets
+        generate 'revelry_content:css'
+      end
 
-      def self.next_migration_number(path)
-        unless @prev_migration_nr
-          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
-        else
-          @prev_migration_nr += 1
+      def add_initializer
+        generate 'revelry_content:initializer'
+      end
+
+      def add_route
+        route 'mount RevelryContent::Engine => "/revelry_content"'
+      end
+
+      def add_controller_concern
+        insert_into_file app_controller, after: 'ApplicationController' do
+          'include RevelryContent::WithRevelryContent'
         end
-        @prev_migration_nr.to_s
       end
 
-      def copy_migrations
-        migration_template "create_revelry_content_contents.rb", "db/migrate/create_revelry_content_contents.rb"
-        migration_template "create_versions.rb", "db/migrate/create_versions.rb"
+      private
+
+      def app_controller
+        File.join('app', 'controllers', 'application_controller.rb')
       end
     end
   end

data/lib/generators/revelry_content/js_generator.rb

@@ -0,0 +1,43 @@
+module RevelryContent
+  module Generators
+    class JsGenerator < ::Rails::Generators::Base
+      JS_FILE_EXTENSIONS = %w(
+        .coffee
+        .coffee.erb
+        .js.coffee
+        .js.coffee.rb
+        .js
+        .js.rb
+      )
+
+      def add_js_assets
+        insert_into_file js_app_bundle, before: %r{(//|#)= require_tree \.} do
+          "#{ js_require_marker }= require revelry_content\n"
+        end
+      end
+
+      private
+
+      def js_app_bundle
+        File.join(js_base_dir, "application#{ js_file_extname }")
+      end
+
+      def test_js_format(fmt)
+        File.exist?(File.join(js_base_dir, "application#{ fmt }"))
+      end
+
+      def js_base_dir
+        File.join('app', 'assets', 'javascripts')
+      end
+
+      def js_file_extname
+        JS_FILE_EXTENSIONS.find { |fmt| test_js_format(fmt) }
+      end
+
+      def js_require_marker
+        '#' if js_file_extname.include?('coffee')
+        '//'
+      end
+    end
+  end
+end

data/lib/generators/revelry_content/migrations_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/migration'
+
+module RevelryContent
+  module Generators
+    class MigrationsGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "add the migrations"
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template "create_revelry_content_contents.rb", "db/migrate/create_revelry_content_contents.rb"
+        migration_template "create_versions.rb", "db/migrate/create_versions.rb"
+      end
+    end
+  end
+end

data/lib/generators/revelry_content/templates/initializer.rb

@@ -0,0 +1,13 @@
+RevelryContent.configure do |config|
+  config.user_for_content do |controller|
+    # Your authentication logic here
+    controller.current_user
+  end
+
+  config.authorization_policy do |user|
+    # Your authorization logic here
+    user.admin?
+  end
+
+  config.js_export = true
+end

data/lib/revelry_content/version.rb

@@ -1,3 +1,3 @@
 module RevelryContent
-  VERSION = "0.0.1.1"
+  VERSION = "0.0.1.2"
 end

data/test/dummy/app/assets/stylesheets/application.scss

@@ -8,7 +8,6 @@
  * You're free to add application-wide styles to this file and they'll appear at the top of the
  * compiled file, but it's generally better to create a new file per style scope.
  *
+ *= require revelry_content
  *= require_self
  */
-
- @import "revelry_content/application";

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: revelry_content
 version: !ruby/object:Gem::Version
-  version: 0.0.1.1
+  version: 0.0.1.2
 platform: ruby
 authors:
 - Revelry Labs, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-04 00:00:00.000000000 Z
+date: 2015-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -332,9 +332,14 @@ files:
 - app/views/revelry_content/contents/_menus.html.erb
 - app/views/revelry_content/contents/index.html.erb
 - config/routes.rb
+- lib/generators/revelry_content/css_generator.rb
+- lib/generators/revelry_content/initializer_generator.rb
 - lib/generators/revelry_content/install_generator.rb
+- lib/generators/revelry_content/js_generator.rb
+- lib/generators/revelry_content/migrations_generator.rb
 - lib/generators/revelry_content/templates/create_revelry_content_contents.rb
 - lib/generators/revelry_content/templates/create_versions.rb
+- lib/generators/revelry_content/templates/initializer.rb
 - lib/revelry_content.rb
 - lib/revelry_content/configuration.rb
 - lib/revelry_content/controller_concern.rb
@@ -582,7 +587,6 @@ files:
 - test/dummy/tmp/cache/assets/development/sprockets/v3.0/y_4IIBYH_ItxQoEeXjWm9Igwn6hAkl669CNtYfo0fyI.cache
 - test/dummy/tmp/cache/assets/development/sprockets/v3.0/zF_lfa7oUNjRgtepm9Ufi0DCzN_IXCJTDHRrH-JHu7Q.cache
 - test/dummy/tmp/cache/assets/development/sprockets/v3.0/zeqXKQA7lKQnvEaJsDO404ZaYCV0dk57z-SXUkfmz24.cache
-- test/dummy/tmp/pids/server.pid
 - test/dummy/vendor/assets/javascripts/revelry_content/content.js
 - test/fixtures/rev_content/contents.yml
 - test/helpers/rev_content/contents_helper_test.rb
@@ -853,7 +857,6 @@ test_files:
 - test/dummy/tmp/cache/assets/development/sprockets/v3.0/ZBbRPnK9QPeL_bLmZNttUrL0MMH6DtrYDpD4f1DbYtc.cache
 - test/dummy/tmp/cache/assets/development/sprockets/v3.0/zeqXKQA7lKQnvEaJsDO404ZaYCV0dk57z-SXUkfmz24.cache
 - test/dummy/tmp/cache/assets/development/sprockets/v3.0/zF_lfa7oUNjRgtepm9Ufi0DCzN_IXCJTDHRrH-JHu7Q.cache
-- test/dummy/tmp/pids/server.pid
 - test/dummy/vendor/assets/javascripts/revelry_content/content.js
 - test/fixtures/rev_content/contents.yml
 - test/helpers/rev_content/contents_helper_test.rb

data/test/dummy/tmp/pids/server.pid

@@ -1 +0,0 @@
-68157