jabysoft-base 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f17919c27f0cc74b82f52ba6b387009d3ae59a7
+  data.tar.gz: 725159bc10e219a37759cd92fdb8142e26d17a8c
+SHA512:
+  metadata.gz: b7e30299e7bcc7c911508dbba0402f86f18ca7ea80fbc8ab39a40377f7382fd6818546e5eb71ecf4684cbbccbe3b0d826b1bbdca167e6a86251501a984e328d7
+  data.tar.gz: 4f6e6ad160decbb0a6c34465d57ce09409c24c8bab481fd5d566e25f915894cb4e99af969d4ec867afba1e41a0c37150d6d69f06052f0bf6f8490e61716bd52a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+ruby '2.3.1'
+
+# Specify your gem's dependencies in jabysoft-base.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,180 @@
+PATH
+  remote: .
+  specs:
+    jabysoft-base (0.1.1)
+      devise (~> 4.2)
+      factory_girl_rails (~> 4.7)
+      pry-byebug (~> 3.4)
+      rails (~> 5.0)
+      rake (~> 11.0)
+      rspec-rails (~> 3.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      nio4r (~> 1.2)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      actionview (= 5.0.0.1)
+      activejob (= 5.0.0.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.0.1)
+      actionview (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.0.1)
+      activesupport (= 5.0.0.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (5.0.0.1)
+      activesupport (= 5.0.0.1)
+      globalid (>= 0.3.6)
+    activemodel (5.0.0.1)
+      activesupport (= 5.0.0.1)
+    activerecord (5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.1)
+    bcrypt (3.1.11)
+    builder (3.2.2)
+    byebug (9.0.5)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.2)
+    devise (4.2.0)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 4.1.0, < 5.1)
+      responders
+      warden (~> 1.2.3)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    factory_girl (4.7.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.7.0)
+      factory_girl (~> 4.7.0)
+      railties (>= 3.0.0)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (2.0.2)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    nio4r (1.2.1)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    orm_adapter (0.5.0)
+    pkg-config (1.1.7)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.0)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.0.1)
+      actioncable (= 5.0.0.1)
+      actionmailer (= 5.0.0.1)
+      actionpack (= 5.0.0.1)
+      actionview (= 5.0.0.1)
+      activejob (= 5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activerecord (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.0.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.1)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6.0)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (11.2.2)
+    responders (2.2.0)
+      railties (>= 4.2.0, < 5.1)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-rails (3.5.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    sprockets (3.7.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.1.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    warden (1.2.6)
+      rack (>= 1.0)
+    websocket-driver (0.6.4)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  jabysoft-base!
+  simplecov (~> 0.12.0)
+
+RUBY VERSION
+   ruby 2.3.1p112
+
+BUNDLED WITH
+   1.12.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Jabysoft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Jabysoft-base
+[![Gem Version](https://badge.fury.io/rb/jabysoft-base.svg)](https://badge.fury.io/rb/jabysoft-base)
+
+Set of utilities to build rails applications with style.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jabysoft-base'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jabysoft-base
+
+## Usage
+
+Execute jabysoft:setup to initialize your Rails project.
+
+    $ rails generate jabysoft:setup
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jabysoft-base. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/javascripts/jabysoft.js

@@ -0,0 +1 @@
+//= require bootstrap-sprockets

data/app/assets/stylesheets/jabysoft.sass

@@ -0,0 +1,42 @@
+// Import Bootstrap Compass integration
+@import "bootstrap-compass"
+// Import custom Bootstrap variables
+@import "bootstrap-variables"
+// sprockets
+@import "bootstrap-sprockets"
+// Import Bootstrap for Sass
+@import "bootstrap"
+
+body
+  padding-top: $navbar-height + 10px
+
+.page-header
+  a.btn
+    float: right
+
+  a.btn + a.btn
+    margin-right: 8px
+
+input[type="radio"], input[type="checkbox"]
+  width: initial
+  height: initial
+  margin-top: 7px
+
+
+.field_with_errors
+  @extend .has-error !optional
+
+.search-field
+  width: 30%
+
+.alert-notice
+  color: #3c763d
+  background-color: #dff0d8
+  border-color: #d6e9c6
+
+.alert-notice hr
+  border-top-color: #c9e2b3
+
+.alert-notice .alert-link
+  color: #2b542c
+

data/app/controllers/base_controller.rb

@@ -0,0 +1,111 @@
+class BaseController < ApplicationController
+  # This class works as a Restfull CRUD Controller to provide the same
+  # crud functions to all subcontrollers
+  protect_from_forgery with: :exception
+  respond_to :json, :html, :xml
+  before_action :set_resource, only: [:show, :edit, :update, :destroy]
+  before_action :disable_edition, only: [:show]
+  before_action :load, except: [:index, :destroy]
+
+  PER_PAGE = 5
+
+  def index
+    if included_attributes
+      instance_variable_set(collection_instance_variable, model.includes(included_attributes).paginate(page: params[:page], per_page: PER_PAGE))
+    else
+      instance_variable_set(collection_instance_variable, model.paginate(page: params[:page], per_page: PER_PAGE))
+    end
+    search
+    respond_with collection_variable
+  end
+
+  def show
+  end
+
+  def new
+    instance_variable_set(instance_variable, model.new)
+  end
+
+  def edit
+  end
+
+  def create
+    instance_variable_set(instance_variable, model.new(permit_params))
+    flash[:success] = I18n.t('created', model: model.model_name.human) if variable.save
+    responds
+  end
+
+  def update
+    flash[:success] = I18n.t('updated', model: model.model_name.human) if variable.update(permit_params)
+    responds
+  end
+
+  def destroy
+    flash[:success] = I18n.t('destroyed', model: model.model_name.human) if variable.destroy
+    redirect_to index_path
+  end
+
+  def template_not_found
+    redirect_to '/404.html'
+  end
+
+  private
+  def search
+    return unless params[:search].present?
+    result = collection_variable.search(params[:search])
+    instance_variable_set(collection_instance_variable, result)
+  end
+
+  def variable
+    instance_variable_get(instance_variable)
+  end
+
+  def collection_variable
+    instance_variable_get(collection_instance_variable)
+  end
+
+  def controller_namespace
+    params[:controller].split('/').first if params[:controller].include?('/')
+  end
+
+  def instance_variable
+    "@#{model.name.underscore}"
+  end
+
+  def collection_instance_variable
+    "@#{model.name.underscore.pluralize}"
+  end
+
+  def set_resource
+    instance_variable_set(instance_variable, model.find(params[:id]))
+  end
+
+  def responds
+    if controller_namespace
+      respond_with controller_namespace.to_sym, variable
+    else
+      respond_with variable
+    end
+  end
+
+  # to be used by subclasses
+  def included_attributes
+    nil
+  end
+
+  def load
+  end
+
+  protected
+  def model
+    params[:controller].camelize.singularize.constantize if params[:controller]
+  end
+
+  def index_path
+    Rails.application.routes.url_helpers.send("#{params[:controller].camelize.underscore}_path")
+  end
+
+  def disable_edition
+    @readonly = true
+  end
+end

data/app/helpers/base_helper.rb

@@ -0,0 +1,63 @@
+module BaseHelper
+
+  def translate_attribute(model, attribute = nil, options = {})
+    return model.human_attribute_name(attribute) if attribute
+    if options.any?
+      return model.model_name.human.pluralize if options[:pluralize]
+    else
+      model.model_name.human
+    end
+  end
+
+  alias_method :ta, :translate_attribute
+
+  def edit_url_for(model)
+    if model.id
+      path = "edit_#{model.model_name.to_s.underscore}_path"
+      Rails.application.routes.url_helpers.send(path.to_sym, id: model.id)
+    end
+  end
+
+  def edit_admin_url_for(model)
+    if model.id
+      path = "edit_admin_#{model.model_name.to_s.underscore}_path"
+      Rails.application.routes.url_helpers.send(path.to_sym, id: model.id)
+    end
+  end
+
+  def remote_request(type, path, params={}, target_tag_id = nil)
+    if target_tag_id
+      "$.#{type}('#{path}',
+               { #{collect_request_params(params)} },
+               function(data) {$('##{target_tag_id}').html(data);}
+      );"
+    else
+      "$.#{type}('#{path}',
+               { #{collect_request_params(params)} }
+      );"
+    end
+  end
+
+  def boolean_image(boolean)
+    if boolean
+      "<span class='glyphicon glyphicon-ok green'>".html_safe
+    else
+      "<span class='glyphicon glyphicon-remove red'>".html_safe
+    end
+  end
+
+  def short_date(date)
+    return "" unless date
+    l(date, format: :short)
+  end
+
+  def price(value)
+    number_to_currency(value)
+  end
+
+  private
+  def collect_request_params(params)
+    params.collect { |param| "#{param[0]}: #{param[1]}" }.join(", ")
+  end
+
+end

data/app/helpers/devise_helper.rb

@@ -0,0 +1,17 @@
+module DeviseHelper
+
+  def devise_error_messages!
+    return '' if resource.errors.empty?
+
+    messages = resource.errors.full_messages.map { |msg| content_tag(:li, msg) }.join
+    html = <<-HTML
+    <div class="alert alert-error alert-danger"> <button type="button"
+    class="close" data-dismiss="alert">x</button>
+      #{messages}
+    </div>
+    HTML
+
+    html.html_safe
+  end
+
+end

data/app/helpers/links_helper.rb

@@ -0,0 +1,84 @@
+module LinksHelper
+
+  def link_to_new(model, url, html_options = {})
+    button_class = 'btn btn-default btn-lg'
+    html_options.reverse_merge!(class: button_class)
+    authorized = authorize_button :create, model, html_options, button_class if model.present?
+    if authorized
+      link_to t('new', model: model.model_name.human), url, html_options
+    else
+      content_tag(:div, class: 'tooltip-wrapper', "data-title" => I18n.t('not_authorized')) do
+        link_to t('new', model: model.model_name.human), url, html_options
+      end
+    end
+  end
+
+  def link_to_edit(model, url, html_options = {})
+    button_class = 'btn btn-default btn-sm'
+    html_options.reverse_merge!(class: button_class)
+    authorized = authorize_button :update, model, html_options, button_class if model.present?
+    if authorized
+      link_to t('edit'), url, html_options
+    else
+      content_tag(:div, class: 'tooltip-wrapper', "data-title" => I18n.t('not_authorized')) do
+        link_to t('edit'), url, html_options
+      end
+    end
+  end
+
+  def link_to_show(model, url, html_options = {})
+    button_class = 'btn btn-default btn-sm'
+    html_options.reverse_merge!(class: button_class)
+    authorized = authorize_button :read, model, html_options, button_class if model.present?
+    if authorized
+      link_to t('show'), url, html_options
+    else
+      content_tag(:div, class: 'tooltip-wrapper', "data-title" => I18n.t('not_authorized')) do
+        link_to t('show'), url, html_options
+      end
+    end
+  end
+
+  def link_to_destroy(model, url, html_options = {})
+    button_class = 'btn btn-danger glyphicon glyphicon-trash'
+    html_options.reverse_merge!({class: button_class, "data-target" => "#delete-confirmation", "data-toggle" => "modal"})
+    authorized = authorize_button :destroy, model, html_options, button_class if model.present?
+    if authorized
+      link_to '', url, html_options
+    else
+      content_tag(:div, class: 'tooltip-wrapper', "data-title" => I18n.t('not_authorized')) do
+        link_to t('destroy'), url, html_options
+      end
+    end
+  end
+
+  def link_to_back(url, html_options = {})
+    html_options.reverse_merge!(class: 'btn btn-default')
+    link_to t('back'), url, html_options
+  end
+
+  def submit_or_edit_button(form, edit_path, is_edition)
+    if is_edition && params[:action] != 'new'
+      link_to_edit form.object, edit_path, class: "btn btn-primary btn-lg"
+    else
+      submit_button(form)
+    end
+  end
+
+  def submit_button(form, value = nil)
+    if value
+      form.submit value, class: "btn btn-primary btn-lg"
+    else
+      form.submit t('save'), class: "btn btn-primary btn-lg"
+    end
+  end
+
+  private
+  def authorize_button(action, model, options, button_class)
+    return true #FIXME - to be removed
+    unless can? action, model
+      options.merge!(class: button_class+" disabled ") and return false
+    end
+    true
+  end
+end

data/app/helpers/render_helper.rb

@@ -0,0 +1,19 @@
+module RenderHelper
+
+  def render_flash_messages
+    render 'shared/messages'
+  end
+
+  def error_messages_for(resource)
+    render partial: 'shared/form/error_messages', locals: { resource: resource }
+  end
+
+  def datepicker_field_for(form, field)
+    render 'shared/datepicker_field', f: form, field: field
+  end
+
+  def search_form(url)
+    render 'shared/search_form', url: url
+  end
+
+end

data/app/models/concerns/extension_model_behaviour.rb

@@ -0,0 +1,16 @@
+module ExtensionModelBehaviour
+  extend ActiveSupport::Concern
+  # It gives model additional scope active and scoped.
+
+  included do
+    scope :active, -> { where(active: true) }
+    scope :scoped, -> { select(:id, scoped_attribute) }
+
+    private
+    def self.scoped_attribute
+      return :code if column_names.include? 'code'
+      :name
+    end
+
+  end
+end