RubyGems - ceo - Versions diffs - 0.1.7 → 0.2.0 - Mend

ceo 0.1.7 → 0.2.0

Files changed (449) hide show

data/app/views/layouts/admin/_header.html.erb ADDED

@@ -0,0 +1,38 @@
+<header class="header--primary">
+  <div class="wrapper">
+    <nav class="header--primary__nav">
+      <ul class="nav nav--primary">
+        <div class="nav--primary__right">
+          <li class="nav__item nav--primary__item">
+            <%= link_to '#', class: 'nav__link nav--primary__link nav--primary__link--user' do %>
+              <div class="user">
+                <div class="user__name">
+                  Admin
+                </div>
+              </div>
+            <% end %>
+            <ul class="nav--dropdown">
+              <li class="nav__item nav--primary__item">
+                <%= link_to "Logout", '#', method: :delete, class: 'nav__link nav--primary__link' %>
+              </li>
+            </ul>
+          </li>
+        </div>
+        <li class="nav__item nav--primary__item nav--primary__item--toggle">
+          <a class="nav__link nav--primary__link nav--primary__link--toggle" toggle-menu="nav--primary__collapse" toggle-modifier="--active">
+            <%= inline_svg "admin/hamburger.svg" %>
+          </a>
+        </li>
+        <div class="nav--primary__collapse">
+          <li class="nav__item nav--primary__item nav--primary__item--left">
+            <%= link_to "Dashboard", admin_path, class: "nav__link nav--primary__link" %>
+          </li>
+          <li class="nav__item nav--primary__item nav--primary__item--left">
+            <%= link_to "Styleguide", admin_styleguide_path, class: 'nav__link nav--primary__link' %>
+          </li>
+        </div>
+      </ul>
+    </nav>
+  </div>
+</header>

data/app/views/layouts/admin/application.html.erb ADDED

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta content="width=device-width, initial-scale=1.0" name="viewport">
+    <title>CEO</title>
+    <%= stylesheet_link_tag 'admin/application' %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <div class="wrapper wrapper--wide">
+      <%= render 'layouts/admin/header' %>
+    </div>
+    <main class="wrapper wrapper--main">
+      <div class="content">
+        <%= yield %>
+      </div>
+    </main>
+  </body>
+</html>

data/config/initializers/simple_form.rb ADDED

@@ -0,0 +1,223 @@
+require 'simple_form'
+# Use this setup block to configure all options available in SimpleForm.
+SimpleForm.setup do |config|
+  # Wrappers are used by the form builder to generate a
+  # complete input. You can remove any component from the
+  # wrapper, change the order or even add your own to the
+  # stack. The options given below are used to wrap the
+  # whole input.
+  config.wrappers :default, class: :input,
+    hint_class: :field_with_hint, error_class: :field_with_errors do |b|
+    ## Extensions enabled by default
+    # Any of these extensions can be disabled for a
+    # given input by passing: `f.input EXTENSION_NAME => false`.
+    # You can make any of these extensions optional by
+    # renaming `b.use` to `b.optional`.
+    # Determines whether to use HTML5 (:email, :url, ...)
+    # and required attributes
+    b.use :html5
+    # Calculates placeholders automatically from I18n
+    # You can also pass a string as f.input placeholder: "Placeholder"
+    b.use :placeholder
+    ## Optional extensions
+    # They are disabled unless you pass `f.input EXTENSION_NAME => true`
+    # to the input. If so, they will retrieve the values from the model
+    # if any exists. If you want to enable any of those
+    # extensions by default, you can change `b.optional` to `b.use`.
+    # Calculates maxlength from length validations for string inputs
+    b.optional :maxlength
+    # Calculates pattern from format validations for string inputs
+    b.optional :pattern
+    # Calculates min and max from length validations for numeric inputs
+    b.optional :min_max
+    # Calculates readonly automatically from readonly attributes
+    b.optional :readonly
+    ## Inputs
+    b.use :label_input
+    b.use :hint,  wrap_with: { tag: :span, class: :hint }
+    b.use :error, wrap_with: { tag: :span, class: :error }
+    ## full_messages_for
+    # If you want to display the full error message for the attribute, you can
+    # use the component :full_error, like:
+    #
+    # b.use :full_error, wrap_with: { tag: :span, class: :error }
+  end
+  config.wrappers :ceo, class: 'list__item list__item--form',
+    hint_class: :field_with_hint, error_class: :field_with_errors do |b|
+    ## Extensions enabled by default
+    # Any of these extensions can be disabled for a
+    # given input by passing: `f.input EXTENSION_NAME => false`.
+    # You can make any of these extensions optional by
+    # renaming `b.use` to `b.optional`.
+    # Determines whether to use HTML5 (:email, :url, ...)
+    # and required attributes
+    b.use :html5
+    # Calculates placeholders automatically from I18n
+    # You can also pass a string as f.input placeholder: "Placeholder"
+    b.use :placeholder
+    ## Optional extensions
+    # They are disabled unless you pass `f.input EXTENSION_NAME => true`
+    # to the input. If so, they will retrieve the values from the model
+    # if any exists. If you want to enable any of those
+    # extensions by default, you can change `b.optional` to `b.use`.
+    # Calculates maxlength from length validations for string inputs
+    b.optional :maxlength
+    # Calculates pattern from format validations for string inputs
+    b.optional :pattern
+    # Calculates min and max from length validations for numeric inputs
+    b.optional :min_max
+    # Calculates readonly automatically from readonly attributes
+    b.optional :readonly
+    ## Inputs
+    b.use :label, class: 'label'
+    b.use :input, class: 'input'
+    b.use :hint,  wrap_with: { tag: :span, class: :hint }
+    b.use :error, wrap_with: { tag: :span, class: :error }
+    ## full_messages_for
+    # If you want to display the full error message for the attribute, you can
+    # use the component :full_error, like:
+    #
+    # b.use :full_error, wrap_with: { tag: :span, class: :error }
+  end
+  # The default wrapper to be used by the FormBuilder.
+  config.default_wrapper = :default
+  # Define the way to render check boxes / radio buttons with labels.
+  # Defaults to :nested for bootstrap config.
+  #   inline: input + label
+  #   nested: label > input
+  config.boolean_style = :inline
+  # Default class for buttons
+  config.button_class = 'button'
+  # Method used to tidy up errors. Specify any Rails Array method.
+  # :first lists the first message for each field.
+  # Use :to_sentence to list all errors for each field.
+  # config.error_method = :first
+  # Default tag used for error notification helper.
+  config.error_notification_tag = :div
+  # CSS class to add for error notification helper.
+  config.error_notification_class = 'error_notification'
+  # ID to add for error notification helper.
+  # config.error_notification_id = nil
+  # Series of attempts to detect a default label method for collection.
+  # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
+  # Series of attempts to detect a default value method for collection.
+  # config.collection_value_methods = [ :id, :to_s ]
+  # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
+  # config.collection_wrapper_tag = nil
+  # You can define the class to use on all collection wrappers. Defaulting to none.
+  # config.collection_wrapper_class = nil
+  # You can wrap each item in a collection of radio/check boxes with a tag,
+  # defaulting to :span. Please note that when using :boolean_style = :nested,
+  # SimpleForm will force this option to be a label.
+  # config.item_wrapper_tag = :span
+  # You can define a class to use in all item wrappers. Defaulting to none.
+  # config.item_wrapper_class = nil
+  # How the label text should be generated altogether with the required text.
+  config.label_text = lambda { |label, required, explicit_label| "#{required} #{label}" }
+  # You can define the class to use on all labels. Default is nil.
+  # config.label_class = 'label'
+  # You can define the default class to be used on forms. Can be overriden
+  # with `html: { :class }`. Defaulting to none.
+  # config.default_form_class = nil
+  # You can define which elements should obtain additional classes
+  config.generate_additional_classes_for = [:input]
+  # Whether attributes are required by default (or not). Default is true.
+  # config.required_by_default = true
+  # Tell browsers whether to use the native HTML5 validations (novalidate form option).
+  # These validations are enabled in SimpleForm's internal config but disabled by default
+  # in this configuration, which is recommended due to some quirks from different browsers.
+  # To stop SimpleForm from generating the novalidate option, enabling the HTML5 validations,
+  # change this configuration to true.
+  config.browser_validations = false
+  # Collection of methods to detect if a file type was given.
+  # config.file_methods = [ :mounted_as, :file?, :public_filename ]
+  # Custom mappings for input types. This should be a hash containing a regexp
+  # to match as key, and the input type that will be used when the field name
+  # matches the regexp as value.
+  # config.input_mappings = { /count/ => :integer }
+  # Custom wrappers for input types. This should be a hash containing an input
+  # type as key and the wrapper that will be used for all inputs with specified type.
+  # config.wrapper_mappings = { string: :prepend }
+  # Namespaces where SimpleForm should look for custom input classes that
+  # override default inputs.
+  # config.custom_inputs_namespaces << "CustomInputs"
+  # Default priority for time_zone inputs.
+  # config.time_zone_priority = nil
+  # Default priority for country inputs.
+  # config.country_priority = nil
+  # When false, do not use translations for labels.
+  # config.translate_labels = true
+  # Automatically discover new inputs in Rails' autoload path.
+  # config.inputs_discovery = true
+  # Cache SimpleForm inputs discovery
+  # config.cache_discovery = !Rails.env.development?
+  # Default class for inputs
+  # config.input_class = nil
+  # Define the default class of the input wrapper of the boolean input.
+  config.boolean_label_class = 'checkbox'
+  # Defines if the default input wrapper class should be included in radio
+  # collection wrappers.
+  # config.include_default_input_wrapper_class = true
+  # Defines which i18n scope will be used in Simple Form.
+  # config.i18n_scope = 'simple_form'
+  config.wrappers :hidden, :tag => 'div', :class => '', :error_class => '' do |b|
+    b.use :html5
+    b.use :label_input, :wrap_with => nil
+  end
+  config.wrapper_mappings = { :hidden => :hidden }
+end

data/config/routes.rb ADDED

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+  namespace :admin do
+    get '/', to: 'admin#dashboard'
+    get 'styleguide', to: 'admin#styleguide'
+  end
+end

data/lib/ceo.rb CHANGED

@@ -3,6 +3,8 @@ require 'ceo/engine'
 require 'ceo/rails/routes'
 require 'ceo/paginator'
 require 'ceo/iterator'
+require 'inline_svg'
 module CEO
 end

data/lib/ceo/engine.rb CHANGED

@@ -2,3 +2,4 @@ module CEO
   class Engine < Rails::Engine
   end
 end

data/lib/ceo/iterator.rb CHANGED

@@ -3,15 +3,12 @@ module CEO
   #
   # Examples
   #
-  #   iterator = CEO::Iterator.new(Apple, current_page: filters: { only: [:id, :name] })
+  #   iterator = CEO::Iterator.new(Apple, current_page: 2, filters: { only: [:id, :name] })
   #   iterator.total_pages
   #   # => 7
   #   iterator.current_page
   #   # => 2
   class Iterator
-    # Public: Returns the current page.
-    attr_reader :current_page
     # Public: Returns the total pages paginated.
     attr_reader :total_pages
@@ -147,6 +144,7 @@ module CEO
       things.select { |thing| whitelist.include? thing }
     end
+    # Public: Returns the current page.
     def current_page
       (@options[:current_page] || 1).to_i
     end

data/lib/ceo/version.rb CHANGED

@@ -1,3 +1,3 @@
 module CEO
-  VERSION = '0.1.7'
+  VERSION = '0.2.0'
 end

data/lib/generators/admin/admin_generator.rb CHANGED

@@ -22,7 +22,10 @@ class AdminGenerator < Rails::Generators::NamedBase
     end
     create_file "app/views/admin/#{@controller.underscore}/_form.html.erb", <<VIEW
-<% # "f" is exposed as a form object %>
+<% # "f" is exposed as a form object (example below) %>
+<%= f.input :name %>
+<%= f.button :submit %>
 VIEW
   end
 end

data/lib/generators/admin/templates/admin_page_controller.rb.erb CHANGED

@@ -1,5 +1,6 @@
 module Admin
-  class <%= @controller.camelize %>Controller < AdminController
-    # leave empty for basic CRUD
+  class <%= @controller.camelize %>Controller < CEOController
+    # Leave empty for basic CRUD, or change CEOController to AdminController to
+    # override basic CRUD.
   end
 end

data/test/ceo/authenticate_admin_test.rb ADDED

@@ -0,0 +1,47 @@
+require 'test_helper'
+class Admin::AuthenticateAdminTest < ActionController::TestCase
+  describe 'controller inheriting from AdminController' do
+    before do
+      @controller = Admin::ApplesController.new
+    end
+    it "calls #authenticate_admin!" do
+      mock = MiniTest::Mock.new
+      mock.expect(:call, false)
+      @controller.stub(:authenticate_admin!, mock) do
+        get :index
+      end
+      mock.verify
+    end
+    describe 'when #authenticate_admin! is not defined by app' do
+      it 'returns false when calling #authenticate_admin!' do
+        assert_equal false, @controller.authenticate_admin!
+      end
+    end
+    describe 'when #authenticate_admin! is defined by app' do
+      before do
+        ApplicationController.class_eval do
+          def authenticate_admin!
+            "hi!"
+          end
+        end
+      end
+      after do
+        ApplicationController.class_eval do
+          remove_method :authenticate_admin!
+        end
+      end
+      it 'defers to whatever the app defines as #authenticate_admin!' do
+        assert_equal "hi!", @controller.authenticate_admin!
+      end
+    end
+  end
+end

data/test/ceo/edit_apple_test.rb CHANGED

@@ -18,7 +18,7 @@ describe 'apples admin pages' do
       apple_name = 'Red Delicious'
       fill_in 'apple[name]', with: apple_name
-      click_button 'submit'
+      click_button 'Update Apple'
       assert_equal 200, page.status_code
       new_apple = Apple.find(@apple.id).attributes
@@ -35,14 +35,14 @@ describe 'apples admin pages' do
     it 'should error when validation is nil' do
       fill_in 'banana[name]', with: nil
-      click_button 'submit'
+      click_button 'Update Banana'
       assert page.has_css?('.field_with_errors')
     end
     it 'should error when validation is empty' do
       fill_in 'banana[name]', with: ''
-      click_button 'submit'
+      click_button 'Update Banana'
       assert page.has_css?('.field_with_errors')
     end

data/test/ceo/index_apple_test.rb CHANGED

@@ -4,79 +4,75 @@ describe 'Apple admin pages' do
   include AcceptanceHelper
   describe 'index' do
-    before do
-      30.times { Apple.create }
-      admin_page '/apples'
-    end
-    it 'should not error when there are no apples' do
-      Apple.delete_all
-      admin_page '/apples'
+    describe 'without apples' do
+      it 'should not error' do
+        admin_page '/apples'
-      assert_equal 0, Apple.count
-      expected_text = 'There are no apples in the database.'
-      assert page.has_css?('p', text: expected_text)
+        assert_equal 0, Apple.count
+        assert page.has_content? 'There are no apples in the database.'
+      end
     end
-    describe 'correct attributes' do
-      let(:attributes) { Apple.new.attributes.keys }
-      it 'should have the right number of headers' do
-        headers = page.all('table thead th')
-        assert_equal attributes.size, headers.size
+    describe 'with apples' do
+      before do
+        21.times { Apple.create }
+        admin_page '/apples'
       end
-      it 'should have the right header names' do
-        assert page.has_css?('table thead tr th', text: 'ID')
-        assert page.has_css?('table thead tr th', text: 'Name')
-        assert page.has_css?('table thead tr th', text: 'Fruit')
-      end
+      describe 'correct attributes' do
+        let(:attributes) { Apple.new.attributes.keys }
-      it 'should have all IDs shown' do
-        Apple.all.each do |a|
-          page.has_css?('table tbody tr td', text: a.id.to_s)
+        it 'should have the right number of headers' do
+          headers = page.all('table thead th')
+          assert_equal attributes.size + 2, headers.size # 2 function headers (edit & show)
         end
-      end
-    end
-    it 'it should include a new button' do
-      el = page.find('a#new-apple')
-      assert_equal '/admin/apples/new', el['href']
-      assert_equal 'New Apple', el.text
-    end
+        it 'should have the right header names' do
+          assert page.has_css?('table thead tr th', text: 'ID')
+          assert page.has_css?('table thead tr th', text: 'Name')
+          assert page.has_css?('table thead tr th', text: 'Fruit')
+        end
-    describe 'pagination' do
-      it 'shows 20 apples per page' do
-        assert_equal 20, page.all('table tbody tr').size
-        refute_equal 20, Apple.count
+        it 'should have all IDs shown' do
+          Apple.all.each do |a|
+            page.has_css?('table tbody tr td', text: a.id.to_s)
+          end
+        end
       end
-      describe 'pagination links' do
-        describe 'first page' do
-          it 'should have a disabled link' do
-            el = page.find('nav ul li a', text: '1')
-            assert_equal '1', el.text
-            assert el['href'].nil?
-          end
+      it 'it should include a new button' do
+        assert page.has_link? 'New Apple'
+      end
-          it 'should have a link to the next page' do
-            el = page.find('nav ul li a', text: '2')
-            assert_equal '/admin/apples/page/2', el['href']
-          end
+      describe 'pagination' do
+        it 'shows 20 apples per page' do
+          assert_equal 20, page.all('table tbody tr').size
+          refute_equal 20, Apple.count
         end
-        describe 'second page' do
-          before { visit '/admin/apples/page/2' }
+        describe 'pagination links' do
+          describe 'first page' do
+            it 'should have a disabled link' do
+              assert el = find('ul li a', text: '1')
+              assert el['href'].nil?
+            end
-          it 'should have a disabled link' do
-            el = page.find('nav ul li a', text: '2')
-            assert_equal '2', el.text
-            assert el['href'].nil?
+            it 'should have a link to the next page' do
+              assert all("a[href='/admin/apples/page/2']").length > 0
+            end
           end
-          it 'should have a first page button' do
-            el = page.find('nav ul li a', text: '1')
-            assert_equal '/admin/apples/page/1', el['href']
+          describe 'second page' do
+            before { visit '/admin/apples/page/2' }
+            it 'should have a disabled link' do
+              assert el = find('ul li a', text: '2')
+              assert el['href'].nil?
+            end
+            it 'should have a first page button' do
+              assert all("a[href='/admin/apples/page/1']").length > 0
+            end
           end
         end
       end