basepack 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db881493cb9c532a418fea20b75359a4ecba6520
-  data.tar.gz: 097ce9f20af7db454b57b60074f1b1fca0f1338c
+  metadata.gz: 42b4c4e9de574ee382862177ef70d09534fdde0b
+  data.tar.gz: 62e39464fbf10f75dd1f47ed47806b430ceceaf1
 SHA512:
-  metadata.gz: 54b88969c6d58bc1a50f3ca736cbf6d7655b1ee6d97382bdb3316716009bfaa4cc7179cd454f02e8021701c8917ef53463e87ceaf62301579196bfb9d5f39e9f
-  data.tar.gz: 03af11a78d8072bfb87fffeae449eb8faca8b89ec3aff3cea09aca750fe7767ba84260464e6bb5bdfeae08a1a6b8ab867162bceb32f8ba97a6ee6712992181ad
+  metadata.gz: 6a1b4624838eee920a54a6103b470cea5bcb417b3388697b455507c1e1a893c43fbfc22a54e127dab2610bd926b5efd2ede84c6c5b25507b9610f5d8364e1880
+  data.tar.gz: aeef6cc1cab16311d1fb27c9e5648f30184c36eb0f7f75bf576c6a50eadb4d62493b99a11cc21b5405b1f1a1a94eacb71bae250f95909ba70e6b120de073abf5

data/Gemfile

@@ -16,7 +16,7 @@ group :test, :development do
   gem 'capybara'
   gem 'warden'
   gem 'database_cleaner'
-  gem 'dragonfly', '>= 0.9'
+  gem 'dragonfly', '~> 1.0.2'
   gem 'rack-cache', :require => 'rack/cache'
   gem 'paperclip', '>= 3.4'
   gem 'timecop'
@@ -32,7 +32,7 @@ group :test, :development do
   gem 'sass-rails', '~> 4.0.0'
   gem 'bootstrap-sass', '~> 2.2'
   gem 'launchy'
-  gem "twitter-bootstrap-rails"
+  gem "twitter-bootstrap-rails", "~> 2.2.8"
   gem "selenium-webdriver"
   gem "simple_form"
 end

data/README.md

@@ -1,10 +1,20 @@
 Basepack
 =======
+[![Gem Version](https://badge.fury.io/rb/basepack.png)](http://badge.fury.io/rb/basepack)
 [![Build Status](https://api.travis-ci.org/lksv/basepack.png?branch=master)](http://travis-ci.org/lksv/base_pack)
 [![Dependency Status](https://gemnasium.com/lksv/basepack.png)](https://gemnasium.com/lksv/basepack)
 
 **Basepack** is a Ruby on Rails framework for quick creation of information
-systems.
+systems. 
+
+**Basepack** dramatically helps you to start your new project.
+There are out of the box form fields like: date (datepicker), datetime, html5
+wysiwig, tags, file upload and others. Further more there is support for 
+dynamic field hiding depending on state of other fields as well as
+options of selectbox content modifications dependant on other fields.
+
+**Basepack** contains a lot of predefined forms, views and actions which you might need
+(filter form, bulk changes, delete\_all, import, export, ...).
 
 ## Features
 
@@ -15,18 +25,24 @@ systems.
 * Automatic form validation
 * Import and Export functionality for resource
 * Easy way to create custom actions
+* Security: permited parameters are automatically defined against fields in edit forms which are (read-write).
 * Authentication (via [Devise](ttps://github.com/plataformatec/devise))
 * Authorization (via [Cancan](https://github.com/ryanb/cancan.git))
 
+All the field form definitions are done by [RailsAdmin](https://github.com/sferik/rails_admin) and are configured
+accordingly.  It simplifies configuration process and if you wish to use
+RailsAdmin as an admin interface.
+
+
 ## Documentation
 
-[Turorial](https://github.com/lksv/basepack/wiki/Tutorial)
+[Tutorial](https://github.com/lksv/basepack/wiki/Tutorial)
 
 See project [wiki](https://github.com/lksv/basepack/wiki).
 
 ## Demo
 
-*currently we are preparing 
+*Currently [zorec](https://github.com/zorec) is preparing 
 [basepace_example application](https://github.com/zorec/basepack_example)*
 
 The running application will be available at [http://basepack-example.herokuapp.com/](http://basepack-example.herokuapp.com/)
@@ -35,7 +51,7 @@ The running application will be available at [http://basepack-example.herokuapp.
 
 In your `Gemfile`, add the following dependencies:
 
-    gem "basepack",      git: "https://github.com/lksv/basepack.git"
+    gem "basepack"
 
 Run:
 
@@ -45,23 +61,13 @@ And then run:
 
     rails g basepack:install
 
-This generator will install **Basepack**, 
-[Devise](https://github.com/plataformatec/devise) and
-[CanCan](https://github.com/ryanb/cancan.git) and following gems
-* inherited\_resources
-* ransack
-* kaminari
-* simple\_form
-* settingslogic
-* twitter-bootstrap-rails
-* bootbox-rails
-
-if you don't already have them installed.
+The generator will install several gems. Also, generator asks to delete 
+`app/views/layouts/application.html.erb` because differend .haml version will be created.
+If you don't know what to answer then answer 'yes' to generator's question.
 
-Define inital ability in `app/models/ability.rb`. You can put ```can
-:manage, :all``` to enable anybody to perform any
-action on any object. See more on [CanCan
-wiki](https://github.com/ryanb/cancan/wiki/Defining-Abilities).
+In a bigger project do not forget to change ability in `app/models/ability.rb`. By
+default, the generator adds ```can :manage, :all``` to enable anybody to perform any action on any object. 
+See more on [CanCan wiki](https://github.com/ryanb/cancan/wiki/Defining-Abilities).
 
 Migrate your database and start the server:
 
@@ -82,14 +88,20 @@ Then
 ```rake db:migrate```
 ```rails s```
 
-Notice that files for views are not generated (directories appp/views/projects and appp/views/tasks are empty), but all RESTful actions are working correctly. It is because views iherit default structure and you can easily override these defaults by creating appropriate files.
+Notice that:
+1. Generated controllers inherits form ResourcesController.
+2. Files for views are not generated (directories appp/views/projects 
+and appp/views/tasks are empty), but all RESTful actions are working correctly. 
+It is because views inherit default structure from controller inheritance) 
+and you can easily override these defaults by creating appropriate files.
 
 ## Basic usage
 
 After scaffolding your resources, you can customize fields used in individual actions by [Railsdmin DSL](https://github.com/sferik/rails_admin/wiki/Railsadmin-DSL)
 
 File ```app/models/project.rb```:
-```
+
+```ruby
 class Project < ActiveRecord::Base
   has_many :tasks, inverse_of: :project
   validates :name, :short_description, presence: true
@@ -120,16 +132,27 @@ end
 ```
 
 File ```app/models/task.rb```
-```
+```ruby
 class Task < ActiveRecord::Base
   belongs_to :project, inverse_of: :tasks
-  belongs_to :user
+  belongs_to :user, inverse_of: :tasks
 end
 ```
-IMPORTANT! Make sure that you define inverse_of option on has_one, has_many and belongs_to associations. It is necessary for correct functioning of **Basepack**, see [Rails documentation](http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html#label-Bi-directional+associations) for explaination.
+
+Add folowing line to ```app/models/user``` file:
+```ruby
+   has_many tasks, inverse_of: user
+```
+
+Pleas note that ```inverse_of``` option is included on association. It is 
+necessary for correct functioning of **Basepack**, see 
+[Rails documentation](http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html#label-Bi-directional+associations) 
+and [RailsAdmin
+wiki](https://github.com/sferik/rails_admin/wiki/Associations-basics#inverse_of-avoiding-edit-association-spaghetti-issues) 
+for explaination.
 
 
-Another difference is controllers which inherit from ResourcesController. Full inheritance hierarchy looks this way:
+Almoust all the staff what Baseback do is through  Basepack::BaseController which inherit from ResourcesController. Full inheritance hierarchy looks this way:
 ```
 ProjectsController < ResourcesController < Basepack::BaseController < InheritedResources::Base
 ```
@@ -137,18 +160,14 @@ ProjectsController < ResourcesController < Basepack::BaseController < InheritedR
 
 If you are not familiar with [InheritedResources](https://github.com/josevalim/inherited_resources), take a look at it.  
 
-Basepack::BaseController adds to it:
-* strong parameters handling
-* ```options``` method
-* ```taggings``` method
-* ```build_resource``` method
-
 You do NOT need to define permitted parameters anymore. It is defined by RailsAdmin DSL, more precisely by what you set as visible in edit action. 
 So file ```app/models/project.rb```:
 
-```
+```ruby
 class Project < ActiveRecord::Base
-  ...
+  #...
+  rails_admin do
+    #...
     edit do
       field :name
       field :short_description
@@ -156,7 +175,7 @@ class Project < ActiveRecord::Base
       field :start
       field :finish
      end 
-  ...
+   end
 end
 ```
 
@@ -191,14 +210,7 @@ background architecture it is recommended to get to know at least with:
 **Basepack** was also
 inspired by [RailsAdmin](https://github.com/sferik/rails_admin) and
 still using [RailsAdmin
-DSL](https://github.com/sferik/rails_admin/wiki/Railsadmin-DSL) for defining the forms.
-
-TODO - explain the concept. Class ```Basepack::Form::Base``` and ```Basepack::Form::Fields::Base```.
-Controller action as ```<form_name>_form_for``` and ```form_factory_rails_admin```.
-
-## Customining Views
-
-## Customizing Form View
+DSL](https://github.com/sferik/rails_admin/wiki/Railsadmin-DSL) for defining the forms, sessins and fields group.
 
 License
 =======
@@ -208,8 +220,16 @@ This project rocks and uses LGPL-LICENSE.
 Credits
 =======
 
-[RailsAdmin](https://github.com/sferik/rails_admin) field forms was
+[RailsAdmin](https://github.com/sferik/rails_admin) field views and some forms (export form) was
 originaly taken from rails-admin.
 
 [nested_form_ui](https://github.com/tb/nested_form_ui) - stylesheed and
 code for orderable was inspired by this project.
+
+
+
+
+
+
+
+[![Analytics](https://ga-beacon.appspot.com/UA-46491076-2/basepack/README.md?pixel)](https://github.com/igrigorik/ga-beacon)

data/app/assets/javascripts/basepack/loading_spinner.coffee.erb

@@ -6,10 +6,10 @@
       @remove_spinner()
   spinner_html: '
     <div class="modal hide fade" id="page-spinner">
-      <div class="modal-head card-title"> <%= I18n.t :loading %></div>
+      <div class="modal-head card-title"> <%= I18n.t :"misc.loading" %></div>
       <div class="modal-body card-body">
         <i class="icon-spinner icon-spin icon-2x"></i>
-        &emsp;<%= I18n.t :loading %>
+        &emsp;<%= I18n.t :"misc.loading" %>
       </div>
     </div>
   '

data/app/controllers/basepack/base_controller.rb

@@ -159,7 +159,7 @@ module Basepack
         if filter.save
           flash.now[:notice] = message_new_done(Basepack::Utils.model_config(filter_class).label)
         else
-          flash.now[:error] = I18n.t :error_filter, scope: [:misc]
+          flash.now[:error] = I18n.t('basepack.query.error_filter')
         end
       end
 
@@ -491,6 +491,27 @@ module Basepack
       end
     end
 
+    # Returns array of associations which are automatically included within
+    # list form. Is is particulary handfull when you are showing some value
+    # form associated model in the list column.
+    # For example, image you need to show list of task with their assigne:
+    # class Task < ActiveRecord::Base
+    #   belongs_to :assigne, class_name: 'User'
+    #   delegate :name, to: assignee, prefix: true
+    #   rails_admin do
+    #     list do
+    #       field :name
+    #       field :assignee_name
+    #     end
+    #   end
+    # end
+    #
+    # This method returns all association of defined fields which are
+    # belongs_to_association or has_one_association type
+    # Association from the example above is included by default.
+    #
+    # You can extend/redefine this method in subclass for futher include.
+    #
     def collection_includes
       resource_config.fields.select do |f|
         f.type.in?([:belongs_to_association, :has_one_association]) && !f.polymorphic?

data/app/views/forms/_bulk_edit.html.haml

@@ -1,7 +1,7 @@
 .form-bulk-edit
   = form.render_form do
 
-    %h3 Bulk edit for #{form.collection.count} items
+    %h3= I18n.t('basepack.bulk_edit.title', count: form.collection.count)
 
     = form_display_base_errors(form.resource)
     .form-inputs

data/app/views/forms/_export.html.haml

@@ -1,6 +1,7 @@
 .form-export
   .well.well-small
-    Počet záznamů pro export:
+    = I18n.t('basepack.export.no_exported_items', default: [:'admin.export.no_exported_items'])
+    \:
     %b= export_form.collection.total_count
 
   = form_tag form.path, method: 'post', class: 'form-horizontal denser' do
@@ -14,9 +15,9 @@
           %label.checkbox{:for => 'check_all'}
             = 'Vybrat všechny pole'
             = check_box_tag 'check_all', 'all', true, data: {toggle: "checkboxes", target: "input[name^='schema[]']"}
-      %legend= t('admin.export.select')
+      %legend= t('basepack.export.select', default: [:'admin.export.select'])
       .control-group
-        %label.control-label{"data-toggle" => 'tooltip', title: t('admin.export.click_to_reverse_selection'), :onclick => 'jQuery(this).siblings(".controls").find("input").click()'}= t('admin.export.fields_from', :name => resource_config.label_plural.downcase)
+        %label.control-label{"data-toggle" => 'tooltip', title: t('basepack.export.click_to_reverse_selection', default: [:'admin.export.click_to_reverse_selection']), :onclick => 'jQuery(this).siblings(".controls").find("input").click()'}= t('basepack.export.fields_from', default: [:'admin.export.fields_from'], :name => resource_config.label_plural.downcase)
         .controls
           - form.visible_fields.select {|f| !f.association? || f.polymorphic? }.each do |field|
             %label.checkbox{for: "schema_#{field.name}"}
@@ -25,7 +26,7 @@
 
       - form.visible_fields.select {|f| f.association? && !f.polymorphic? }.each do |field|
         .control-group
-          %label.control-label{"data-toggle" => 'tooltip', title: t('admin.export.click_to_reverse_selection'), :onclick => 'jQuery(this).siblings(".controls").find("input").click()'}= t('admin.export.fields_from_associated', :name => field.label.downcase)
+          %label.control-label{"data-toggle" => 'tooltip', title: t('basepack.export.click_to_reverse_selection', default: [:'admin.export.click_to_reverse_selection']), :onclick => 'jQuery(this).siblings(".controls").find("input").click()'}= t('basepack.export.fields_from_associated', default: [:'admin.export.fields_from_associated'], :name => field.label.downcase)
           .controls
             - field.nform.visible_fields.reject {|f| f.association? }.each do |afield|
               %label.checkbox{:for => "schema_#{field.name}_#{afield.name}"}
@@ -33,38 +34,38 @@
                 = afield.label
 
     %fieldset
-      %legend= t('admin.export.options_for', :name => 'csv')
+      %legend= t('basepack.export.options_for', default: [:'admin.export.options_for'], :name => 'csv')
       -#.control-group
       -#  - guessed_encoding = (Rails.configuration.database_configuration[Rails.env]['encoding'].presence rescue 'UTF-8') || 'UTF-8'
-      -#  %label.control-label{:for => "csv_options_encoding_to"}= t('admin.export.csv.encoding_to')
+      -#  %label.control-label{:for => "csv_options_encoding_to"}= t('basepack.export.csv.encoding_to', default: [:'admin.export.csv.encoding_to'])
       -#  .controls
       -#    -# from http://books.google.com/support/partner/bin/answer.py?answer=30990 :
       -#    = select_tag 'csv_options[encoding_to]', options_for_select(["", "UTF-8", "UTF-16LE", "UTF-16BE", "UTF-32LE", "UTF-32BE", "UTF-7", "ISO-8859-1", "ISO-8859-15", "IBM-850", "MacRoman", "Windows-1252", "ISO-8859-3", "IBM-852", "ISO-8859-2", "MacCE", "Windows-1250", "IBM-855", "ISO-8859-5", "ISO-IR-111", "KOI8-R", "MacCyrillic", "Windows-1251", "CP-866", "KOI-U", "MacUkranian", "GB2312", "GBK", "GB18030", "HZ", "ISO-2022-CN", "Big5", "Big5-HKSCS", "EUC-TW", "EUC-JP", "ISO-2022-JP", "Shift_JIS", "EUC-KR", "UHC", "JOHAB", "ISO-2022-KR"])
-      -#    %p.help-block= t('admin.export.csv.encoding_to_help', :name => guessed_encoding)
+      -#    %p.help-block= t('basepack.export.csv.encoding_to_help', default: [:'admin.export.csv.encoding_to_help'], :name => guessed_encoding)
 
       .control-group
-        %label.control-label{:for => "csv_options_skip_header"}= t('admin.export.csv.skip_header')
+        %label.control-label{:for => "csv_options_skip_header"}= t('basepack.export.csv.skip_header', default: [:'admin.export.csv.skip_header'])
         .controls
           = check_box_tag 'csv_options[skip_header]', 'true'
-          %p.help-block= t('admin.export.csv.skip_header_help')
+          %p.help-block= t('basepack.export.csv.skip_header_help', default: [:'admin.export.csv.skip_header_help'])
 
       .control-group
-        %label.control-label{:for => "csv_options_col_sep"}= t('admin.export.csv.col_sep')
+        %label.control-label{:for => "csv_options_col_sep"}= t('basepack.export.csv.col_sep.label', default: [:'admin.export.csv.col_sep'])
         .controls
           = select_tag 'csv_options[col_sep]',
               options_for_select({'' => Basepack::Settings.export.default_col_sep,
-                "<comma> ','"     => ',',
-                "<semicolon> ';'" => ';',
-                '<tabs>'          => "'\t'" })
-          %p.help-block= t('admin.export.csv.col_sep_help', :value => Basepack::Settings.export.default_col_sep)
+                t('basepack.export.csv.col_sep.comma')      => ',',
+                t('basepack.export.csv.col_sep.semicolon')  => ';',
+                t('basepack.export.csv.col_sep.tab')        => "'\t'" })
+          %p.help-block= t('basepack.export.csv.col_sep_help', default: [:'admin.export.csv.col_sep_help'], :value => Basepack::Settings.export.default_col_sep)
 
     .form-actions
       .pull-right
         %button.btn.btn-primary{:type => "submit", :name => 'csv'}
           %i.icon-white.icon-ok
-          = t("admin.export.confirmation", :name => 'csv')
+          = t("basepack.export.confirmation", default: :"admin.export.confirmation", :name => 'csv')
         %button.btn.btn-info{:type => "submit", :name => 'json'}
-          = t("admin.export.confirmation", :name => 'json')
+          = t("basepack.export.confirmation", default: :"admin.export.confirmation", :name => 'json')
         %button.btn.btn-info{:type => "submit", :name => 'xml'}
-          = t("admin.export.confirmation", :name => 'xml')
+          = t("basepack.export.confirmation", default: :"admin.export.confirmation", :name => 'xml')
 

data/app/views/forms/_import.html.haml

@@ -11,8 +11,8 @@
         .pull-right
           = render "forms/buttons/refresh"
 
-  %legend Nový import
+  %legend= t('basepack.import.new_import')
   = form.edit_form.render
 
-  %legend Seznam importů
+  %legend= t('basepack.import.import_list')
   = form.list_form.render

data/app/views/forms/_import_configuration_csv.html.haml

@@ -1,17 +1,20 @@
-%legend Konfigurace CSV importu
+%legend= I18n.t('basepack.import.csv.configuration')
 
 = form.render_form do
   .form-inputs
-    = form.builder.input :col_sep, label: t('admin.export.csv.col_sep') do
+    = form.builder.input :col_sep, label: t('basepack.export.csv.col_sep.label') do
       %select{name: "import[configuration][col_sep]"}
-        = options_for_select({"<comma> ','" => ',', "<semicolon> ';'" => ';', '<tabs>' => "'\t'"}, configuration[:col_sep] || ',')
-    = form.builder.input :blank_vals, label: 'Prázdné hodnoty' do
+        = options_for_select({I18n.t('basepack.export.csv.col_sep.comma') => Basepack::Settings.import.default_col_sep,
+          I18n.t('basepack.export.csv.col_sep.semicolon') => ';',
+          I18n.t('basepack.export.csv.col_sep.tab') => "'\t'"},
+          configuration[:col_sep] || ',')
+    = form.builder.input :blank_vals, label: I18n.t('basepack.import.csv.blank_vals.label') do
       %select{name: "import[configuration][blank_vals]"}
-        = options_for_select({"Přeskočit" => 'skip', "Nastavit" => 'use'}, configuration[:blank_vals] || 'skip')
+        = options_for_select({I18n.t('basepack.import.csv.blank_vals.skip') => 'skip', I18n.t('basepack.import.csv.blank_vals.use') => 'use'}, configuration[:blank_vals] || 'skip')
     %hr
     - mapping = configuration[:mapping] || []
     - csv_cols.each_with_index do |col, i|
-      = form.builder.input :"col_#{i}", label: html_escape(col.presence || "Sloupec #{i + 1}") do
+      = form.builder.input :"col_#{i}", label: html_escape(col.presence || I18n.t('basepack.import.csv.column', idx: i+1)) do
         %select{name: "import[configuration][mapping][]"}
           = options_for_select(select_options, select_options.find {|o| o[0] == col} || mapping[i])
   .form-actions
@@ -20,4 +23,4 @@
       %button.btn.btn-primary{type: "submit", name: "import[state]", value: "not_started",
           'data-disable-with' => "<i class='icon-white icon-ok'></i> #{t("admin.form.save")}"}
         %i.icon-white.icon-ok
-        Spustit
+        = I18n.t('basepack.import.csv.start')

data/app/views/forms/_query.html.haml

@@ -3,7 +3,7 @@
          html: {method: :post, id: 'filter-form', class: 'form-horizontal form-search'} do |f|
     .modal-header
       = render 'forms/buttons/modal_close'
-      %h3= I18n.t('admin.misc.filter')
+      %h3= I18n.t('basepack.query.filter')
 
     .modal-body
       = form_display_base_errors form.resource_filter
@@ -11,12 +11,12 @@
         = yield(:query)
       - else
         .input-append
-          = text_field_tag 'query', form.query, autofocus: true, placeholder: I18n.t('admin.misc.filter'), class: "search-query"
-          %button{type: "submit", class: "btn", title: I18n.t('admin.misc.filter'), 'data-disable-with' => "<i class='icon-search'></i>"}
+          = text_field_tag 'query', form.query, autofocus: true, placeholder: I18n.t('basepack.query.filter'), class: "search-query"
+          %button{type: "submit", class: "btn", title: I18n.t('basepack.query.filter'), 'data-disable-with' => "<i class='icon-search'></i>"}
             %i.icon-search
       #complex-filters-menu.dropdown.pull-right
         %a.btn.dropdown-toggle{href: "#", "data-toggle" => "dropdown"}
-          = I18n.t('admin.misc.add_filter')
+          = I18n.t('basepack.query.add_filter')
           %span.caret
         = render "forms/query_menu", form: form
       .clearfix
@@ -35,18 +35,18 @@
       - unless form.edit_ql
         = button_tag class: 'btn', name: 'edit_ql', data: {"remote-form" => "parent=form", "remote-target" => "parent=.form-query"} do
           %i.icon-pencil
-          =I18n.t('misc.modify_query')
+          =I18n.t('basepack.query.modify_query')
       - if Basepack::Settings.filters.model_name and can?(:create, Basepack::Settings.filters.model_name.constantize)
         = hidden_field_tag 'filter_name'
-        = button_tag class: 'btn', id: 'filter-add', title: I18n.t('misc.save_filter') do
+        = button_tag class: 'btn', id: 'filter-add', title: I18n.t('basepack.query.save_filter') do
           %i.icon-plus
-          =I18n.t('misc.save_filter')
+          =I18n.t('basepack.query.save_filter')
         :javascript
           jQuery(function($) {
             $("#filter-add").click(function(e) {
               e.preventDefault();
 
-              bootbox.prompt(#{I18n.t('misc.enter_filter_name').to_json}, function(result) {
+              bootbox.prompt(#{I18n.t('basepack.query.enter_filter_name').to_json}, function(result) {
                 if (result) {
                   $('#filter-form input[name=filter_name]').val(result);
                   $('#filter-form').submit();