basepack 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db881493cb9c532a418fea20b75359a4ecba6520
+  data.tar.gz: 097ce9f20af7db454b57b60074f1b1fca0f1338c
+SHA512:
+  metadata.gz: 54b88969c6d58bc1a50f3ca736cbf6d7655b1ee6d97382bdb3316716009bfaa4cc7179cd454f02e8021701c8917ef53463e87ceaf62301579196bfb9d5f39e9f
+  data.tar.gz: 03af11a78d8072bfb87fffeae449eb8faca8b89ec3aff3cea09aca750fe7767ba84260464e6bb5bdfeae08a1a6b8ab867162bceb32f8ba97a6ee6712992181ad

data/Gemfile

@@ -0,0 +1,46 @@
+source "https://rubygems.org"
+ruby '2.0.0'
+
+# Declare your gem's dependencies in basepack.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+group :test, :development do
+  gem 'sqlite3'
+  gem 'cancan'
+  gem 'devise'
+  gem 'rspec-rails'
+  gem 'factory_girl_rails'
+  gem 'faker'
+  gem 'capybara'
+  gem 'warden'
+  gem 'database_cleaner'
+  gem 'dragonfly', '>= 0.9'
+  gem 'rack-cache', :require => 'rack/cache'
+  gem 'paperclip', '>= 3.4'
+  gem 'timecop'
+  gem 'settingslogic'
+  gem 'ransack'
+
+  gem "simple_form"
+  gem 'poltergeist'
+  gem 'jquery-rails'
+  gem "jquery-turbolinks"
+  gem "turbolinks"
+  gem "bootbox-rails"
+  gem 'sass-rails', '~> 4.0.0'
+  gem 'bootstrap-sass', '~> 2.2'
+  gem 'launchy'
+  gem "twitter-bootstrap-rails"
+  gem "selenium-webdriver"
+  gem "simple_form"
+end
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/README.md

@@ -0,0 +1,215 @@
+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.
+
+## Features
+
+* Quick development of forms - generates forms for resource by short DSL metadata
+  settings.
+* Rich set of business types support (datetime, wysiwig, tags, phone number, ...)
+* Search and filtering, saved filters
+* Automatic form validation
+* Import and Export functionality for resource
+* Easy way to create custom actions
+* Authentication (via [Devise](ttps://github.com/plataformatec/devise))
+* Authorization (via [Cancan](https://github.com/ryanb/cancan.git))
+
+## Documentation
+
+[Turorial](https://github.com/lksv/basepack/wiki/Tutorial)
+
+See project [wiki](https://github.com/lksv/basepack/wiki).
+
+## Demo
+
+*currently we are 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/)
+
+## Installation
+
+In your `Gemfile`, add the following dependencies:
+
+    gem "basepack",      git: "https://github.com/lksv/basepack.git"
+
+Run:
+
+    bundle install
+
+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.
+
+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).
+
+Migrate your database and start the server:
+
+    rake db:migrate
+    rails s
+
+
+## Generator usage
+
+You can easily generate new resource (scaffold for the resource) by
+```rails g scaffold NAME [field[:type][:index] field[:type][:index]] [options]```.
+E.g.
+
+    rails g scaffold Project name short_description description:text start:date finish:date
+    rails g scaffold Task name description:text project:references user:references
+
+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.
+
+## 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```:
+```
+class Project < ActiveRecord::Base
+  has_many :tasks, inverse_of: :project
+  validates :name, :short_description, presence: true
+
+  rails_admin do
+    list do
+      field :name
+      field :short_description
+      field :finish
+    end
+
+    edit do
+      field :name
+      field :short_description
+      field :description, :wysihtml5
+      field :start
+      field :finish
+     end 
+
+     show do
+       field :name
+       field :description
+       field :start
+       field :finish
+     end 
+  end 
+end
+```
+
+File ```app/models/task.rb```
+```
+class Task < ActiveRecord::Base
+  belongs_to :project, inverse_of: :tasks
+  belongs_to :user
+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.
+
+
+Another difference is controllers which inherit from ResourcesController. Full inheritance hierarchy looks this way:
+```
+ProjectsController < ResourcesController < Basepack::BaseController < InheritedResources::Base
+```
+
+
+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```:
+
+```
+class Project < ActiveRecord::Base
+  ...
+    edit do
+      field :name
+      field :short_description
+      field :description, :wysihtml5
+      field :start
+      field :finish
+     end 
+  ...
+end
+```
+
+implicitly sets permitted params which could be written as:
+```
+def permitted_params
+  params.permit(:project => [:name, :short_description, :description, :start, :finish])
+end
+```
+in your projects controller. You can override these implicit settings by creating this method in case you want it.
+
+## Basic Architecture Background
+
+**Basepack** is build on the top of several gems:
+* [Device](https://github.com/plataformatec/devise) for Authentication
+* [CanCan](https://github.com/ryanb/cancan.git) for Authorization
+* [InheritedResources](https://github.com/josevalim/inherited_resources)
+   makes your controllers inherit all restful actions.
+* [SimpleForm](https://github.com/plataformatec/simple_form) for
+  creating Forms.
+* [nested-form](https://github.com/ryanb/nested_form) for handling
+  multiple models in a single form
+* [bootstrap-sass](https://github.com/thomas-mcdonald/bootstrap-sass)
+* ...[and others](basepack.gemspec)
+
+Althoug you can use **Basepack** without knowing anything of the
+background architecture it is recommended to get to know at least with:
+[InheritedResources](https://github.com/josevalim/inherited_resources),
+[CanCan](https://github.com/ryanb/cancan.git) and
+[Device](https://github.com/plataformatec/devise). 
+
+**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
+
+License
+=======
+
+This project rocks and uses LGPL-LICENSE.
+
+Credits
+=======
+
+[RailsAdmin](https://github.com/sferik/rails_admin) field forms 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.

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy_app/Rakefile", __FILE__)
+
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec
+

data/app/assets/javascripts/basepack/forms/query/date.jst.ejs

@@ -0,0 +1,8 @@
+<input class="date additional-fieldset default input-medium" type="text" style="display: none;"
+  name="<%- name %>"
+  value="<%- value %>"
+/>
+<!--
+  data-datetimepicker="true"
+  data-options="%- JSON.stringify(options) %"
+-->

data/app/assets/javascripts/basepack/forms/query/filter.jst.ejs

@@ -0,0 +1,15 @@
+<div class="filter form-search filter-<%= index %>">
+  <a href="#" class="delete btn btn-mini btn-danger pull-right"><i class="icon-trash icon-white"></i></a>
+  <% if (name_control) { %>
+    <%= name_control %>
+  <% } else { %>
+    <input type="hidden" name="<%- condition_name %>" value="<%- field_name %>"/>
+  <% } %>
+  <div class="control-group">
+    <label class="control-label"><%- field_label %></label>
+    <div class="controls">
+      <%= control %>  <%= additional_control %>
+      <input type="hidden" name="<%- value_name %>" value="1" disabled="disabled" class="boolean-value"/>
+    </div>
+  </div>
+</div>

data/app/assets/javascripts/basepack/forms/query/predicate.jst.ejs

@@ -0,0 +1,7 @@
+<select class="input-medium predicate <%- klass %>" name="<%- name %>">
+  <% $.each(options, function(i, o) { %>
+    <option value="<%= o %>"  <%= o == selected ? 'selected="selected"' : '' %> data-type="<%- predicates[o].type %>">
+      <%- predicates[o].label %>
+    </option>
+  <% }) %>
+</select>

data/app/assets/javascripts/basepack/forms/query.coffee

@@ -0,0 +1,126 @@
+class Basepack.QueryForm
+
+  constructor: ($container, $menu) ->
+    @$container = $container
+    @$filters = @$container.find(".filters")
+    @$menu = $menu
+    @options =
+      regional:
+        datePicker:
+          dateFormat: "mm/dd/yy"
+      predicates: { }
+      enum_options: { }
+
+    that = @
+
+    @$menu.on "click", "a[data-field-label]", (e) ->
+      e.preventDefault()
+      that.append $(@).data("field-label"),
+                  $(@).data("field-name"),
+                  $(@).data("field-type"),
+                  $(@).data("field-value"),
+                  $(@).data("field-operator"),
+                  $(@).data("field-template"),
+                  $.now().toString().slice(6, 11)
+
+    @$container.on "click", ".delete", (e) ->
+      e.preventDefault()
+      form = $(@).parents("form")
+      $(@).parents(".filter").remove()
+      not that.$filters.children().length and that.$container.hide("fast")
+
+    @$container.on "change", ".predicate", (e) ->
+      that.setup_additional_control $(@)
+
+  setup: (data) ->
+    @options = data.options
+    for field, i in data.initial
+      @append field.label, field.name, field.type, field.value, field.predicate, field.template, i
+
+  setup_additional_control: ($predicate_select) ->
+    selected_option = $predicate_select.find("option:selected")
+    if $(selected_option).data("type") is "boolean"
+      $predicate_select.siblings(".additional-fieldset").prop("disabled", true).hide()
+      $predicate_select.siblings(".boolean-value").prop "disabled", false
+    else
+      $predicate_select.siblings(".additional-fieldset").prop("disabled", false).show()
+      $predicate_select.siblings(".boolean-value").prop "disabled", true
+
+  select_option: (name, selected, options, klass) ->
+    html = "<select class=\"input-medium #{klass || "additional-fieldset"}\" name=\"" + name + "\">"
+    $.each options, (i, o) ->
+      html += "<option value=\"" + o[0] + "\"" + ((if o[0] is selected then " selected=\"selected\"" else "")) + ">" + o[1] + "</option>"
+
+    html + "</select>"
+
+  select_predicate: (name, value, options, klass) ->
+    JST["basepack/forms/query/predicate"]
+      name: name
+      value: value
+      options: options
+      klass: klass
+      predicates: @options.predicates
+      selected: value or "cont"
+
+  append: (field_label, field_name, field_type, field_value, field_predicate, field_template, index) ->
+    condition_name = "f[c][" + index + "][a][0][name]"
+    value_name = "f[c][" + index + "][v][0][value]"
+    operator_name = "f[c][" + index + "][p]"
+
+    if field_template
+      console.log(field_template)
+      control = _.template(field_template)
+        label: field_label,
+        type: field_type,
+        value: field_value || {},
+        predicate: field_predicate,
+        index: index,
+        name: value_name,
+        field_name: field_name,
+        condition_name: condition_name,
+        operator_name: operator_name,
+        select_option: @.select_option
+    else
+      switch field_type
+        when "boolean"
+          control = @select_predicate(operator_name, field_predicate or "true", ["true", "false", "null", "not_null"])
+        when "date", "datetime", "timestamp"
+          control = @select_predicate(operator_name, field_predicate or "eq", ["eq", "not_eq", "lt", "lteq", "gt", "gteq", "present", "blank", "null", "not_null"])
+          additional_control = JST["basepack/forms/query/date"]
+            name: value_name,
+            value: field_value,
+            #options: { showTime: false, datepicker: _.defaults({value: field_value}, @options.regional.datePicker) }
+        when "enum"
+          #var multiple_values = ((field_value instanceof Array) ? true : false)
+          control = @select_predicate(operator_name, field_predicate or "eq", ["eq", "not_eq", "null", "not_null"])
+          additional_control = @select_option(value_name, field_value, @options.enum_options[field_name] or [])
+        when "string", "text", "belongs_to_association"
+          control = @select_predicate(operator_name, field_predicate or "cont", ["eq", "not_eq", "matches", "does_not_match", "cont", "not_cont", "start", "not_start", "end", "not_end", "present", "blank", "null", "not_null"])
+          additional_control = "<input class=\"additional-fieldset input-medium\" type=\"text\" name=\"" + value_name + "\" value=\"" + field_value + "\" /> "
+        when "integer", "decimal", "float"
+          control = @select_predicate(operator_name, field_predicate or "eq", ["eq", "not_eq", "lt", "lteq", "gt", "gteq", "null", "not_null"])
+          additional_control = "<input class=\"additional-fieldset default input-medium\" type=\"text\" name=\"" + value_name + "\" value=\"" + field_value + "\" /> "
+        when "ql"
+          name_control = " "
+          control = "<textarea name=\"" + field_name + "\" class=\"input-xlarge\" rows=\"4\" cols=\"50\">" + field_value + "</textarea>"
+        else
+          control = "<input type=\"hidden\" name=\"" + operator_name + "\" value=\"eq\"/>"
+          additional_control = "<input type=\"text\" class=\"input-medium\" name=\"" + value_name + "\" value=\"" + field_value + "\"/> "
+
+    content = JST["basepack/forms/query/filter"]
+      index: index,
+      name_control: name_control,
+      condition_name: condition_name,
+      field_name: field_name,
+      field_label: field_label
+      control: control,
+      additional_control: additional_control,
+      value_name: value_name
+
+    @$filters.append content
+    @$container.show "fast"
+    @$filters.find(".filter-#{index} .date").datepicker @options.regional.datePicker
+    @.setup_additional_control $(el) for el in @$filters.find(".predicate[name=\"#{operator_name}\"]")
+    form = new Basepack.Form(@$filters.find(".filter-#{index}"))
+    form.bind()
+