shoestrap 1.0.0.pre3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dd1664ff03eceb5244ebbe95ed3bf3820019621
-  data.tar.gz: b85a06876965e48d6cd18d01fc3dfafcc20bd886
+  metadata.gz: b55de56d065f7ee9e83d2fe37589e882ea9aed96
+  data.tar.gz: b071ba2c4aa2b53c3d0fbfbf552b568948d5e939
 SHA512:
-  metadata.gz: 6f20b5a995193ed3903de4bcae6b0c591fa08255b87521063d0e05eb7aa7245838e86d36d5b45793d56ecfe6899d342305cd4bceee80f8a227f89f627c3eea8f
-  data.tar.gz: 8f72be11198fd660455aeb916886d458d2de588ea104a6910bf107ae0617f643621ceab9993ef349509abdea66041053586a3a6d35ab6b030f5c1a969662839c
+  metadata.gz: c564e07a2a4f2db6b34fe6776ba2d90591a17a04486b4b1bbb5908947e8f11ccae61253656e95f126536c12a7432a9bba34bf155fd9765d6ab91c2e6d95eddfd
+  data.tar.gz: 526244fef52e7144ac7e177d5be3a94e42a8343db8e277514e94c7496b9872ef61dad9a585ad37ff5b5adeea8380199c1af8ace510e486ee114489eb13d32399

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.0.0 - 2013-09-26
+
+- Cleaned up cms generator
+
 ## 1.0.0.pre3 - 2013-09-18
 
 - Implemented CMS Generator

data/README.md

@@ -11,11 +11,7 @@ work. Your mileage may vary!
 # Features
 
 * generate new rails apps with a sc flavored setup
-* generate admin backens similar to rails_admin and ative_admin, with
-  some notable differences:
-
-  TBD: elaborate on differences between rails_admin/active_admin, i.e
-  why whe built it
+* generate admin backends with view inheritance and inhertied_resources
 
 ## Test shoestrap "compliance"
 

data/features/shoestrap/commands/new_command_spec.rb

@@ -214,11 +214,6 @@ describe 'application generated with shoestrap new <application_name>' do
       expect(application_rb_content).to match "g.helper false"
     end
 
-    it 'uses simple_form as form builder' do
-      expect(application_rb_content).to match(/form_builder :simple_form/)
-    end
-
-
     context 'mailcatcher' do
       it 'is configured for development environment' do
         expect(development_rb_content).to match(/config\.action_mailer\.delivery_method = :smtp/)

data/features/shoestrap/generators/cms_generator_spec.rb

@@ -2,7 +2,7 @@ require_relative '../../features_helper'
 
 describe 'rails generate shoestrap:cms' do
 
-  context 'without default cms' do
+  context 'without kuhsaft' do
 
     options = {kuhsaft: false}
     let(:cars_controller) { application_file('app/controllers/cms/cars_controller.rb', options) }
@@ -20,8 +20,7 @@ describe 'rails generate shoestrap:cms' do
     context 'generating a cms resource' do
       let(:navigation_config_path) { File.join(app_path, 'config/navigation.rb') }
       let(:navigation_config) { application_file('config/navigation.rb', options) }
-      let (:gemfile_content) { application_file('Gemfile', options) }
-
+      let(:gemfile_content) { application_file('Gemfile', options) }
 
       before :all do
         rails 'generate shoestrap:cms car tires:integer model:string', options
@@ -32,37 +31,23 @@ describe 'rails generate shoestrap:cms' do
           expect(application_file('config/routes.rb', options)).to match(/namespace :cms do/)
         end
 
-        context 'with navigation' do
-          it 'sets up the cms navigation file' do
-            expect(File.exists? navigation_config_path).to be_true
-          end
-
-          it 'contains no example entries' do
-            expect(navigation_config).not_to match(/^\s*primary\.item :key/)
-          end
-        end
-
         it 'sets up controller inheritance for the cms backend' do
-          expect(application_file('app/controllers/shoestrap/base_controller.rb', options)).to match('InheritedResources::Base')
+          expect(application_file('app/controllers/shoestrap/base_controller.rb', options)).to match('ActionController::Base')
+          expect(application_file('app/controllers/shoestrap/base_controller.rb', options)).to match('inherit_resources')
         end
 
+        it 'generates inherited resource views' do
+          views = Dir[File.join(app_path, 'app/views/shoestrap/base/*.html.haml')]
+          views.map!{|v| v.scan(/^.+app\/views\/shoestrap\/base\/(.*).html.haml/).flatten.first.to_sym }
+          expected_action_views = [:edit, :index, :new, :"_form"]
+          expect(expected_action_views - views).to be_empty
+        end
       end
 
-
-      it 'generates a controller with CRUD actions' do
-        expect(cars_controller).to match(/Shoestrap..BaseController/)
-        expect(cars_controller).to match('respond_to :html')
-        expect(cars_controller).to match(/action.+all.+except.+show/)
-        expect(cars_controller).not_to match(/Cms::Car\./)
-        expect(cars_controller).not_to match(/params\[:cms_car\]/)
-      end
-
-      it 'generates inherited CRUD views' do
-        views = Dir[File.join(app_path, 'app/views/cms/cars/*.html.haml')]
-        views.map!{|v| v.scan(/^.+app\/views\/cms\/cars\/(.*).html.haml/).flatten.first.to_sym }
-
-        expected_action_views = [:edit, :index, :new, :show]
-        expect(expected_action_views - views).to be_empty
+      context 'generates a CRUD controller' do
+        it 'inherits from the shoestrap base controller' do
+          expect(cars_controller).to match(/Shoestrap..BaseController/)
+        end
       end
 
       it 'generates a model' do
@@ -77,16 +62,6 @@ describe 'rails generate shoestrap:cms' do
         expect(application_file('config/routes.rb', options)).to match(/resources :cars/)
       end
 
-      it 'generates integration tests for the CRUD actions' do
-        request_spec = File.join(app_path, 'spec/requests/cms/cms_cars_spec.rb')
-        expect(File.exists? request_spec).to be_true
-      end
-
-      it 'adds the generated resource to the cms navigation' do
-        expect(navigation_config).to match('cms_cars_path')
-      end
-
-
       it 'does not generate routing specs' do
         routing_spec = File.join(app_path, 'spec/routing/cars_routing_spec.rb')
         expect(File.exists? routing_spec).to be_false
@@ -118,11 +93,12 @@ describe 'rails generate shoestrap:cms' do
   end # without default cms
 
   context 'with kuhsaft' do
-
     options = {kuhsaft: true}
     let(:cars_controller) { application_file('app/controllers/cms/cars_controller.rb', options) }
-    let (:gemfile_content) { application_file('Gemfile', options) }
+    let(:gemfile_content) { application_file('Gemfile', options) }
     let(:app_path){ application_path(options) }
+    let(:navigation_config_path) { File.join(app_path, 'config/cms_navigation.rb') }
+    let(:navigation_config) { application_file('config/cms_navigation.rb', options) }
 
     before :all do
       generate_test_app_with_shoestrap options
@@ -133,8 +109,10 @@ describe 'rails generate shoestrap:cms' do
         rails 'generate shoestrap:cms car tires:integer model:string', options
       end
 
-      it 'generates a controller inheriting from kuhsaft AdminController' do
-        expect(cars_controller).to match('Kuhsaft::Cms::AdminController')
+      context 'the shoestrap base controller' do
+        it 'inherits from the kuhsaft admin controller' do
+          expect(application_file('app/controllers/shoestrap/base_controller.rb', options)).to match('Kuhsaft::Cms::AdminController')
+        end
       end
 
       it 'should contain the kuhsaft gem' do
@@ -144,8 +122,14 @@ describe 'rails generate shoestrap:cms' do
       it 'should have the kuhsaft initializer' do
         expect(File.exists?(File.join(app_path, 'config/initializers/kuhsaft.rb'))).to be_true
       end
-    end
 
+      it 'sets up the cms navigation file' do
+        expect(File.exists? navigation_config_path).to be_true
+      end
 
+      it 'adds the generated resource to the cms navigation' do
+        expect(navigation_config).to match('cms_cars_path')
+      end
+    end
   end # with kuhsaft
 end # rails generate shoestrap:cms

data/lib/generators/shoestrap/cms_generator.rb

@@ -1,53 +1,95 @@
 require 'rails/generators'
+require 'fileutils'
 require_relative '../../shoestrap/shell'
 require_relative 'base_generator'
 
 module Shoestrap
   class CmsGenerator < BaseGenerator
+
+    def set_up_shoestrap_cms
+      unless shoestrap_cms_already_installed?
+        setup_base_controller
+        setup_base_views
+        setup_navigation
+        setup_translation_file
+      end
+    end
+
     def add_route
       generate 'resource_route', resource_route_name
     end
 
     def add_navigation_link
-      link_definition = "\n    primary.item #{model_name.to_sym.inspect}, #{model_name.pluralize.inspect}, cms_#{model_name.pluralize}_path\n"
-      inject_into_file 'config/navigation.rb', link_definition, after: /navigation.items.+do.+primary.*$/
+      if kuhsaft_is_installed?
+        inject_into_file 'config/cms_navigation.rb', :before => 'primary.dom_class = \'nav\'' do
+          "primary.item :#{model_name}_nav, t('cms.#{model_name}.navigation.title'), #{route_name}_path\n    "
+        end
+      end
     end
 
-    def add_model
+    def add_model_and_migration
       generate 'model', model_name
+      #TODO: this results in a very messed up indentation in the model. fix!
+      inject_into_file "app/models/#{model_name}.rb", before: 'end' do
+        "  class << self
+             # define what attributes are shown in form and permitted by strong parameters
+             def editable_attributes
+               []
+             end
+
+             # define what attributes are shown in index view
+             def index_attributes
+               []
+             end
+           end\n
+        "
+      end
     end
 
-    def add_controller
-      generate 'scaffold_controller', resource_route_name, scaffold_controller_options
-
-      controller_content = File.read(controller_path)
-
-      base_controller = kuhsaft_is_used? ? 'Kuhsaft::Cms::AdminController' : 'Shoestrap::BaseController'
-      controller_content.gsub!('ApplicationController', base_controller)
+    def add_resource_translations
+      copy_file 'translations/resource.yml', "config/locales/de/#{model_name}.yml"
+    end
 
-      model_class = resource_route_name.camelize
-      controller_content.gsub!(/#{model_class}\./, model_class.gsub('Cms::','')+'.')
+    def add_controller
+      generate 'controller', controller_name, " --controller-specs=no --view-specs=no"
+      gsub_file "app/controllers/#{controller_name}_controller.rb", 'ApplicationController', 'Shoestrap::BaseController'
+    end
 
-      controller_content.gsub!("params\[:cms_#{model_name}]", "params\[:#{model_name}]")
+    private
 
-      File.open(controller_path, 'w') { |file| file.puts controller_content }
+    def shoestrap_cms_already_installed?
+      File.exists? 'app/controllers/shoestrap/base_controller.rb'
+    end
 
-      inject_into_file controller_path, "  respond_to :html\n", after: /class Cms::.+Controller < #{base_controller}/
-      inject_into_file controller_path, "\n  actions :all, :except => [ :show ]\n", after: /class Cms::.+Controller < #{base_controller}/
+    def setup_base_controller
+      empty_directory 'app/controllers/shoestrap'
+      if kuhsaft_is_installed?
+        template 'base_controller_with_kuhsaft.rb', 'app/controllers/shoestrap/base_controller.rb'
+      else
+        template 'base_controller_without_kuhsaft.rb', 'app/controllers/shoestrap/base_controller.rb'
+      end
     end
 
-    def create_shoestrap_basecontroller_if_kuhsaft_isnt_used
-      copy_file 'base_controller.rb', 'app/controllers/shoestrap/base_controller.rb'
+    def setup_base_views
+      directory 'inherited_views', 'app/views/shoestrap'
     end
 
-    private
+    def setup_navigation
+      if kuhsaft_is_installed?
+        nav_dir = 'app/views/kuhsaft/cms/admin'
+        empty_directory nav_dir
+        copy_file '_main_navigation.html.haml', "#{nav_dir}/_main_navigation.html.haml"
+        copy_file 'cms_navigation.rb', "config/cms_navigation.rb"
+      end
+    end
 
-    def kuhsaft_is_used?
-      !!defined?(Kuhsaft)
+    def setup_translation_file
+      empty_directory 'config/locales/de'
+      copy_file 'translations/shoestrap_base.yml', 'config/locales/de/shoestrap_base.yml'
     end
 
-    def controller_path
-      "app/controllers/#{resource_route_name.pluralize}_controller.rb"
+    def kuhsaft_is_installed?
+      @kuhsaft_is_installed ||= !!defined?(Kuhsaft)
     end
 
     def resource_route_name
@@ -58,8 +100,16 @@ module Shoestrap
       ARGV.first.downcase
     end
 
-    def scaffold_controller_options
-      "--no-routing-specs --no-view-specs --no-controller-specs --no-jbuilder"
+    def plural_name
+      model_name.pluralize
+    end
+
+    def controller_name
+      "cms/#{plural_name}"
+    end
+
+    def route_name
+      controller_name.gsub('/', '_')
     end
   end
 end

data/lib/shoestrap/version.rb

@@ -1,3 +1,3 @@
 module Shoestrap
-  VERSION = "1.0.0.pre3"
+  VERSION = "1.0.0"
 end

data/templates/application_generator/application_template.rb

@@ -25,7 +25,6 @@ inject_into_file 'config/application.rb', :after => "Application < Rails::Applic
     # Customize generators
     config.generators do |g|
       g.stylesheets false
-      g.form_builder :simple_form
       g.template_engine :haml
       g.test_framework :rspec
       g.javascripts false
@@ -39,7 +38,7 @@ end
 # Default Gems (others are added to gemfile by individual generators called after app generation)
 #
 gem 'therubyracer', platforms: :ruby
-gem 'simple_form', '3.0.0.rc'
+gem 'simple_form', '3.0.0'
 gem 'haml'
 gem 'haml-rails'
 gem 'simple-navigation'

data/templates/cms_generator/_main_navigation.html.haml

@@ -0,0 +1,4 @@
+= link_to 'Kuhsaft CMS', kuhsaft.cms_root_path, :class => 'brand'
+%p.navbar-text.pull-right
+  = link_to t('.logout'), '', :method => :delete
+  = render_navigation(:context => :cms)

data/templates/cms_generator/base_controller_with_kuhsaft.rb

@@ -0,0 +1,13 @@
+class Shoestrap::BaseController < Kuhsaft::Cms::AdminController
+  def show
+    super do |format|
+      format.html { redirect_to collection_path }
+    end
+  end
+
+  private
+
+  def permitted_params
+    params.permit(resource_collection_name => collection.editable_attributes)
+  end
+end

data/templates/cms_generator/base_controller_without_kuhsaft.rb

@@ -0,0 +1,15 @@
+class Shoestrap::BaseController < ActionController::Base
+  inherit_resources
+
+  def show
+    super do |format|
+      format.html { redirect_to collection_path }
+    end
+  end
+
+  private
+
+  def permitted_params
+    params.permit(resource_collection_name => collection.editable_attributes)
+  end
+end

data/templates/cms_generator/cms_navigation.rb

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+# Configures your navigation
+SimpleNavigation::Configuration.run do |navigation|
+  navigation.items do |primary|
+    primary.item :pages, Kuhsaft::Page.model_name.human(:count => 2), kuhsaft.cms_pages_path, :highlights_on => %r(/cms$|/cms/pages)
+    primary.dom_class = 'nav'
+  end
+  navigation.selected_class = 'active'
+end

data/templates/cms_generator/inherited_views/base/_form.html.haml

@@ -0,0 +1,9 @@
+= simple_form_for([:cms, resource]), wrapper: :bootstrap do |f|
+  = f.error_notification
+
+  .form-inputs
+    - resource.class.column_names.reject {|c| ['id', 'created_at', 'updated_at'].include? c }.each do |column_name|
+      = f.input column_name
+
+  .form-actions
+    = f.button :submit

data/templates/cms_generator/inherited_views/base/edit.html.haml

@@ -0,0 +1,5 @@
+%h1= t("cms.edit_title", singular_name: t("cms.#{resource_collection_name}.singular_name"))
+
+= render 'form'
+
+= link_to t('cms.back'), collection_path

data/templates/cms_generator/inherited_views/base/index.html.haml

@@ -0,0 +1,28 @@
+%h1= t("cms.index_title", plural_name: t("cms.#{resource_collection_name}.plural_name"))
+
+.row-fluid.actions
+  .pull-right.padded
+    = link_to new_resource_path, :class => 'btn btn-primary' do
+      %i.icon-plus-sign.icon-white
+      = t("cms.#{resource_collection_name}.new", plural_name: resource_collection_name, default: t('cms.default.new'))
+
+%table.table.table-bordered.table-striped
+  %thead
+    %tr
+      - collection.index_attributes.each do |column_name|
+        %th= collection.human_attribute_name column_name
+      %th
+      %th
+
+  %tbody
+    - collection.each do |item|
+      %tr
+        - collection.index_attributes.each do |column_name|
+          %td= item.send(column_name)
+        %td= link_to t("cms.edit"), edit_resource_path(item)
+        %td
+          =link_to resource_path(item), method: :delete, data: { confirm: t('cms.are_you_sure') }, class: 'btn btn-small btn-danger' do
+            %i.icon-trash.icon-white
+            =t('cms.destroy')
+
+%br

data/templates/cms_generator/inherited_views/base/new.html.haml

@@ -0,0 +1,5 @@
+%h1= t("cms.new_title", singular_name: t("cms.#{resource_collection_name}.singular_name"))
+
+= render 'form'
+
+= link_to t('cms.back'), collection_path

data/templates/cms_generator/translations/resource.yml

@@ -0,0 +1,16 @@
+de:
+  cms:
+    news_items:
+      singular_name: TRANSLATEME
+      plural_name: TRANSLATEME
+      navigation_title: TRANSLATEME
+
+  activerecord:
+    attributes:
+      news_item:
+        some_attr: TRANSLATE YOUR ATTRIBUTES
+
+    models:
+      news_item:
+        one: TRANSLATEME
+        other: TRANSLATEME

data/templates/cms_generator/translations/shoestrap_base.yml

@@ -0,0 +1,11 @@
+de:
+  cms:
+    are_you_sure: 'Sind Sie sicher?'
+    destroy: 'Löschen'
+    edit: 'Bearbeiten'
+    back: 'Zurück'
+    index_title: "%{plural_name} Verwalten"
+    edit_title: "%{singular_name} Bearbeiten"
+    new: "Neuer %{singular_name}"
+    default:
+      new: 'Neuer Eintrag'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shoestrap
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre3
+  version: 1.0.0
 platform: ruby
 authors:
 - Felipe Kaufmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-18 00:00:00.000000000 Z
+date: 2013-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -233,7 +233,16 @@ files:
 - templates/bdd_generator/dotrspec
 - templates/bdd_generator/fast_spec_helper.rb
 - templates/bdd_generator/spec_helper.rb
-- templates/cms_generator/base_controller.rb
+- templates/cms_generator/_main_navigation.html.haml
+- templates/cms_generator/base_controller_with_kuhsaft.rb
+- templates/cms_generator/base_controller_without_kuhsaft.rb
+- templates/cms_generator/cms_navigation.rb
+- templates/cms_generator/inherited_views/base/_form.html.haml
+- templates/cms_generator/inherited_views/base/edit.html.haml
+- templates/cms_generator/inherited_views/base/index.html.haml
+- templates/cms_generator/inherited_views/base/new.html.haml
+- templates/cms_generator/translations/resource.yml
+- templates/cms_generator/translations/shoestrap_base.yml
 - templates/coffee_files_generator/application.js.coffee
 - templates/foundation_generator/_mixin.css.sass
 - templates/foundation_generator/_settings.css.sass
@@ -269,9 +278,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3

data/templates/cms_generator/base_controller.rb

@@ -1,2 +0,0 @@
-class Shoestrap::BaseController < InheritedResources::Base
-end