nocms-blocks 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbc9eae202e6ec4df5bdba9d91c4a842e03e2f3d
-  data.tar.gz: 2523df1872e26d06a714b3bc9c8552c49c07c279
+  metadata.gz: f2cf66257239f30210aaadbb2f8d432f895785c7
+  data.tar.gz: 06c8698cc183e064d03e964bc7a33079f3b5acf9
 SHA512:
-  metadata.gz: 841a55342e8a5b30e2a4c4a5c2771d9d231a4ce68fbe483896159823d44332130fc2b09b8ba214927cb395858301565bac8ef03a98e34c9df8e1ca67b7911ec3
-  data.tar.gz: cefb0459db81a0af3dd4e10f3da524b6c6d5359a0aecfe5b1b6cd5664d30c1d09315bc0a5615dab8ad2cea01f16cc5ffd5a3f0b2bc9a0c36c37b883529e0c1fe
+  metadata.gz: 3e3007d50167b177705f8122dbe6794d76cd2653756ee1e637efc45ead948a9b041ce9c11c5a49eacbbfa83954bfe768912c4ba4e42bdab0e73230c3120c07df
+  data.tar.gz: ff4fb7284e5b4fe7324361f3c6c0e51a74b2f374d955eb5f9811b9564bb43df6cde058e881806b8bc4810c6110f3fe211c234278654b5b501606d1562aa92d07

data/CHANGELOG

@@ -1,9 +1,15 @@
+1.1.1
+
+  - Layout generator: It creates the initializer and views for one layout
+
 1.1.0
 
   - I18n behaviour fixed
     * Separated objects cache for translations
     * fields info both in the block and the translation
 
+  - Block duplication enabled
+
   - Globalize dependency correctly specified in the gemspec
 
   - Latest versions of awesome-nested-set (3.0.2) and globalize (5.0.1)

data/README.md

@@ -34,6 +34,21 @@ rails g nocms:blocks
 
 Blocks are thought to be independent and customizable modules of content that can be created, edited or removed on their own, without dependency of any other module or class.
 
+### Creating a new block layout
+
+In the following sections some files will be mentioned (initializers, views, assets...). You can create them by hand or you can use a layout generator by typing:
+
+```
+rails g nocms:blocks:layout LAYOUT_NAME
+```
+
+This will create the following files:
+
+1. `config/initializers/nocms/blocks/LAYOUT_NAME.rb`: An initializer where you can configure the layout (more info on next section).
+2. `app/views/no_cms/blocks/blocks/_LAYOUT_NAME.html.erb`: Public template for the block (more info on next section).
+3. `app/views/no_cms/admin/blocks/blocks/_LAYOUT_NAME.html.erb`: Template for block administration. You can choose not to use it depending on which admin interface you're using.
+4. `app/assets/stylesheets/no_cms/blocks/_LAYOUT_NAME.scss`: Stylesheet asset so you can organize your SCSS code. Of course, you can not use it, but we strongly recommend trying to maintain styles from a block in a separated stylesheet. Notice that you must import (`@import "app/assets/stylesheets/no_cms/blocks/_LAYOUT_NAME.scss"`) it from your application.css.scss or where it should be used.
+
 ### Block layouts
 
 In NoCMS Blocks, block layouts define two main things:

data/lib/generators/nocms/blocks/layout_generator.rb

@@ -0,0 +1,28 @@
+module NoCms
+  module Blocks
+    class LayoutGenerator < Rails::Generators::Base
+
+      source_root File.expand_path("../templates/", __FILE__)
+
+      argument :name, required: true, banner: '<layout name>', desc: 'Name for the block layout'
+
+      def generate_stylesheets
+        template "app/assets/stylesheets/no_cms/blocks/layout.scss.erb", File.join(destination_root, "app/assets/stylesheets/no_cms/blocks", "_#{name}.scss")
+      end
+
+      def generate_views
+        template "app/views/no_cms/blocks/blocks/layout.html.erb", File.join(destination_root, "app/views/no_cms/blocks/blocks", "_#{name}.html.erb")
+        template "app/views/no_cms/admin/blocks/blocks/layout.html.erb", File.join(destination_root, "app/views/no_cms/admin/blocks/blocks", "_#{name}.html.erb")
+      end
+
+      def generate_initializer
+        template "config/initializers/nocms/blocks/layout.rb", File.join(destination_root, "config/initializers/nocms/blocks", "#{name}.rb")
+      end
+
+      def self.namespace
+        "nocms:blocks:layout"
+      end
+
+    end
+  end
+end

data/lib/generators/nocms/blocks/templates/app/assets/stylesheets/no_cms/blocks/layout.scss.erb

@@ -0,0 +1,3 @@
+.block.<%= name %> {
+
+}

data/lib/generators/nocms/blocks/templates/app/views/no_cms/admin/blocks/blocks/layout.html.erb

@@ -0,0 +1,9 @@
+<div class="row">
+  <%%= f.label :field %>
+  <%%= f.text_field :field %>
+</div>
+
+<div class="row">
+  <%%= f.label :second_field %>
+  <%%= f.text_field :second_field %>
+</div>

data/lib/generators/nocms/blocks/templates/app/views/no_cms/blocks/blocks/layout.html.erb

@@ -0,0 +1,3 @@
+<div class="block <%= name%>">
+  <%%= block.text %>
+</div>

data/lib/generators/nocms/blocks/templates/config/initializers/nocms/blocks/layout.rb

@@ -0,0 +1,23 @@
+NoCms::Blocks.configure do |config|
+
+  config.block_layouts['<%= name %>'] = {
+    template: '<%= name %>', # This is the template of this block,
+                                    # used as a partial both in the front
+                                    # and the admin (if you use the nocms-admin gem)
+    fields: { # This is the list of fields a block with this layout would have
+      text: :string,
+  #   long_text: :text,
+  #   image: Image, # You may use another ActiveRecord classes of your own
+    },
+    allow_nested_blocks: true, # A block with this layout may include a list of nested blocks
+                               # This setting is actually used by nocms-admin gem to show
+                               # nested forms
+    nest_levels: [0], # Some layout may not be nestable, or useful only in certain nesting level
+                     # Once again, this setting is used by nocms-admin gem to hide certain
+                     # in nested blocks. When blank, it's assumed there's no restriction.
+    cache_enabled: false # When setting cache_enabled you will be **overriding** the global cache_enabled
+                         # setting. If you don't set a cache setting then it will use the global cache
+                         # setting specified above
+  }
+
+end

data/lib/no_cms/blocks/version.rb

@@ -1,5 +1,5 @@
 module NoCms
   module Blocks
-    VERSION = "1.1.0"
+    VERSION = "1.1.1"
   end
 end

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

@@ -2,8 +2,6 @@
 <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>

data/spec/lib/generators/layout_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+require "generator_spec"
+
+require_relative '../../../lib/generators/nocms/blocks/layout_generator.rb'
+
+describe NoCms::Blocks::LayoutGenerator, type: :generator do
+
+  TMP_ROOT = File.expand_path("../../../../tmp", __FILE__)
+  destination TMP_ROOT
+
+  arguments %w(test_name)
+
+  before do
+    prepare_destination
+    run_generator
+  end
+
+  after do
+    FileUtils.rm_rf(TMP_ROOT)
+  end
+
+  specify "should create the structure" do
+    expect(destination_root).to have_structure {
+      directory "config" do
+        directory "initializers" do
+          directory "nocms" do
+            directory "blocks" do
+              file "test_name.rb" do
+                contains "'test_name'"
+              end
+            end
+          end
+        end
+      end
+      directory "app" do
+        directory "views" do
+          directory "no_cms" do
+            directory "blocks" do
+              directory "blocks" do
+                file "_test_name.html.erb" do
+                  contains 'class="block test_name"'
+                end
+              end
+            end
+            directory "admin" do
+              directory "blocks" do
+                directory "blocks" do
+                  file "_test_name.html.erb"
+                end
+              end
+            end
+          end
+        end
+      end
+    }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nocms-blocks
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Rodrigo Garcia Suarez
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-19 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -117,6 +117,11 @@ files:
 - db/migrate/20140618150651_add_position_to_no_cms_blocks_block.rb
 - db/migrate/20150709132202_add_non_translated_fields_info_to_no_cms_blocks_block.rb
 - db/migrate/20150710112549_move_layout_from_no_cms_blocks_block_translations_to_no_cms_blocks_blocks.rb
+- lib/generators/nocms/blocks/layout_generator.rb
+- lib/generators/nocms/blocks/templates/app/assets/stylesheets/no_cms/blocks/layout.scss.erb
+- lib/generators/nocms/blocks/templates/app/views/no_cms/admin/blocks/blocks/layout.html.erb
+- lib/generators/nocms/blocks/templates/app/views/no_cms/blocks/blocks/layout.html.erb
+- lib/generators/nocms/blocks/templates/config/initializers/nocms/blocks/layout.rb
 - lib/generators/nocms/blocks_generator.rb
 - lib/generators/nocms/templates/config/initializers/nocms/blocks.rb
 - lib/no_cms/blocks/configuration.rb
@@ -349,6 +354,7 @@ files:
 - spec/factories/test_image.rb
 - spec/fixtures/images/logo.png
 - spec/fixtures/images/logo2.png
+- spec/lib/generators/layout_spec.rb
 - spec/models/no_cms/blocks/block_spec.rb
 - spec/models/no_cms/blocks/duplicating_blocks_spec.rb
 - spec/models/no_cms/blocks/i18n_blocks_spec.rb
@@ -612,5 +618,6 @@ test_files:
 - spec/dummy/db/test.sqlite3
 - spec/dummy/db/development.sqlite3
 - spec/dummy/db/migrate/20140304094052_create_test_images.rb
+- spec/lib/generators/layout_spec.rb
 - spec/factories/test_image.rb
 - spec/factories/no_cms/blocks/block.rb