red_base 0.5.0

data/lib/red_base/engine.rb

@@ -0,0 +1,132 @@
+# -----------------------------------------------------------------------------
+#    Red Base - Basic website skel engine
+#    Copyright (C) 2012-2013 Yellowen
+#
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License along
+#    with this program; if not, write to the Free Software Foundation, Inc.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# -----------------------------------------------------------------------------
+require 'fast_gettext'
+require 'modernizr-rails'
+require "compass-rails"
+require 'zurb-foundation'
+require "font-awesome-rails"
+require "devise"
+require "warden"
+require "cancan"
+
+
+module RedBase
+  class Engine < ::Rails::Engine
+
+    isolate_namespace RedBase
+    engine_name "red_base"
+
+    ActiveSupport::Inflector.inflections(:en) do |inflect|
+      inflect.acronym 'API'
+    end
+
+    config.generators do |g|
+      g.test_framework      :rspec,        :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+
+    # Configure logger
+    mattr_accessor :logger
+    @@logger = Logger.new(STDOUT)
+
+    # Permissions configuration
+    mattr_accessor :models_with_permission
+
+    # TODO: create a basic setup for this option
+    @@models_with_permission = ["RedBase::User",
+                                "RedBase::Group",
+                               ]
+
+    def self.models_with_permission=(value)
+      @@models_with_permission.concat(value).uniq!
+    end
+
+
+    # Dashboard url prefix
+    mattr_accessor :dashboard_namespace
+    @@dashboard_namespace = :dashboard
+
+
+    # locales
+    mattr_accessor :locales
+    @@locales = ['en', 'fa']
+
+    def self.setup
+      yield self
+    end
+
+    I18n.locale = :fa
+    # Fast Gettext Configuration
+    Object.send(:include, FastGettext::Translation)
+
+    # TODO: Check for possible error in this configurations
+    @@locale_path = "#{root}/config/locales"
+    FastGettext.add_text_domain 'red_base', :path => @@locale_path, :type => :po
+    # All languages you want to allow
+    FastGettext.default_available_locales = @@locales
+
+    FastGettext.default_text_domain = 'red_base'
+    FastGettext.locale = :fa
+
+    # Site Title
+    mattr_accessor :site_title
+    @@site_title = _("Red Base")
+
+    # Override devise layout
+    config.to_prepare do
+      Devise::SessionsController.layout "red_base/application"
+      Devise::RegistrationsController.layout  "red_base/application"
+      Devise::ConfirmationsController.layout "red_base/application"
+      Devise::UnlocksController.layout "red_base/application"
+      Devise::PasswordsController.layout "red_base/application"
+    end
+    #Devise.omniauth_path_prefix = ["/en", "/fa"]
+
+
+    # Dashboard configurations
+    mattr_accessor :dashboard_modules
+
+    # This class variable should be a hash
+    # that each key is a resource name and its value
+    # is some of these:
+    #       resource: provide resource name explicitly
+    #       title: resource title (will show in dashboard)
+    #       icon: icon class checkout font-awesome
+    @@dashboard_modules = {
+      :auth => {
+        :title => _("Authentication"),
+      }
+    }
+
+
+    def self.dashboard_modules=(value)
+        @@dashboard_modules.merge!(value)
+    end
+
+    # Dashboard default javascript manifest
+    mattr_accessor :dashboard_js_manifest
+    @@dashboard_js_manifest = "controlpanel/application.js"
+
+    # Grape configuration
+    config.paths.add "app/api", glob: "**/*.rb"
+
+  end
+end

data/lib/red_base/exceptions.rb

@@ -0,0 +1,26 @@
+# -----------------------------------------------------------------------------
+#    Red Base - Basic website skel engine
+#    Copyright (C) 2012-2013 Yellowen
+#
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License along
+#    with this program; if not, write to the Free Software Foundation, Inc.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# -----------------------------------------------------------------------------
+
+module RedBase
+  module Exceptions
+    class AuthorizationError < Exception
+
+    end
+  end
+end

data/lib/red_base/i18n.rb

@@ -0,0 +1,35 @@
+# -----------------------------------------------------------------------------
+#    Red Base - Basic website skel engine
+#    Copyright (C) 2012-2013 Yellowen
+#
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License along
+#    with this program; if not, write to the Free Software Foundation, Inc.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# -----------------------------------------------------------------------------
+
+module RedBase
+  class I18n
+
+    RTL = [
+           :fa,
+           :ar
+          ]
+    def self.direction(locale)
+      if RTL.include? locale.to_sym
+        "rtl"
+      else
+        "ltr"
+      end
+    end
+  end
+end

data/lib/red_base/initialize.rb

@@ -0,0 +1,7 @@
+require 'fast_gettext'
+require 'gettext_i18n_rails'
+# TODO: Check for possible error in this configurations
+FastGettext.add_text_domain 'app', :path => 'config/locales', :type => :po
+# All languages you want to allow
+#FastGettext.default_available_locales = ['en', 'fa']
+FastGettext.default_text_domain = 'app'

data/lib/red_base/omniauth/callbacks.rb

@@ -0,0 +1,58 @@
+# -----------------------------------------------------------------------------
+#    Red Base - Basic website skel engine
+#    Copyright (C) 2012-2013 Yellowen
+#
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License along
+#    with this program; if not, write to the Free Software Foundation, Inc.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# -----------------------------------------------------------------------------
+
+module RedBase
+  module Omniauth
+
+    module Callbacks
+
+
+      def default_service_callback
+
+        create_or_find_user
+
+        if @user.persisted?
+          # This will throw if @user is not activated
+          sign_in_and_redirect @user, :event => :authentication
+          set_flash_message(:notice, :success, :kind => __callee__.to_s) if is_navigational_format?
+        else
+          session["devise.omni_data"] = request.env["omniauth.auth"]
+          redirect_to new_user_registration_url
+        end
+      end
+
+
+      if Devise.omniauth_configs.any?
+        Devise.omniauth_configs.keys.each do |provider|
+          unless method_defined? provider
+            send(:define_method, provider.to_sym) {default_service_callback}
+          end
+        end
+      end
+
+      private
+
+      def create_or_find_user
+        # This method is implemented in User model
+        @user = User.find_from_oauth(request.env["omniauth.auth"], current_user)
+      end
+
+    end
+  end
+end

data/lib/red_base/omniauth/callbakcs.rb~

@@ -0,0 +1,7 @@
+module RedBase
+  module omniauth
+    class CallBacks
+
+    end
+  end
+end

data/lib/red_base/omniauth.rb

@@ -0,0 +1,24 @@
+# -----------------------------------------------------------------------------
+#    Red Base - Basic website skel engine
+#    Copyright (C) 2012-2013 Yellowen
+#
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License along
+#    with this program; if not, write to the Free Software Foundation, Inc.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# -----------------------------------------------------------------------------
+
+module RedBase
+  module Omniauth
+    autoload :Callbacks, "red_base/omniauth/callbacks"
+  end
+end

data/lib/red_base/omniauth.rb~

@@ -0,0 +1 @@
+require "red_base/omniauth/callbacks"

data/lib/red_base/plugins.rb

@@ -0,0 +1,44 @@
+# -----------------------------------------------------------------------------
+#    Red Base - Basic website skel engine
+#    Copyright (C) 2012-2013 Yellowen
+#
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License along
+#    with this program; if not, write to the Free Software Foundation, Inc.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# -----------------------------------------------------------------------------
+
+
+module RedBase
+  class Plugins
+
+    @@plugins = {}
+
+    def self.register(plugin_name, plugin_class)
+      # TODO: Re-think this approach. Do we need to keep plugin classes too?
+      if not @@plugins.include? plugin_name
+        @@plugins[plugin_name] = plugin_class
+      end
+    end
+
+    # Return name of all registered plugins
+    def self.names
+      @@plugins.keys
+    end
+
+    # Return the actual plugins hash
+    def self.plugins
+      @@plugins
+    end
+
+  end
+end

data/lib/red_base/version.rb

@@ -0,0 +1,22 @@
+# -----------------------------------------------------------------------------
+#    Red Base - Basic website skel engine
+#    Copyright (C) 2012-2013 Yellowen
+#
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License along
+#    with this program; if not, write to the Free Software Foundation, Inc.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# -----------------------------------------------------------------------------
+
+module RedBase
+  VERSION = "0.5.0"
+end

data/lib/red_base.rb

@@ -0,0 +1,30 @@
+# -----------------------------------------------------------------------------
+#    Red Base - Basic website skel engine
+#    Copyright (C) 2012-2013 Yellowen
+#
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License along
+#    with this program; if not, write to the Free Software Foundation, Inc.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# -----------------------------------------------------------------------------
+
+require "devise"
+
+module RedBase
+end
+
+require "red_base/engine"
+require "red_base/dashboard"
+require "red_base/omniauth"
+require "red_base/active_record"
+require "red_base/i18n"
+require "red_base/plugins"

data/lib/tasks/grunt/Gruntfile.js

@@ -0,0 +1,25 @@
+module.exports = function (grunt) {
+    grunt.initConfig({
+        nggettext_extract: {
+            pot: {
+                files: {
+                    'app/assets/templates/locale/templates.pot': ['app/assets/templates/*.html']
+                }
+            }
+        },
+        nggettext_compile: {
+            all: {
+                options: {
+                    module: "Dashboard"
+                },
+                files: {
+                    'app/assets/javascripts/red_base/dashboard/locale/translations.js': ['app/assets/templates/locale/*.po']
+                }
+            }
+        }
+
+    });
+
+    grunt.loadNpmTasks('grunt-angular-gettext');
+    grunt.registerTask('default', ['nggettext_extract', 'nggettext_compile']);
+};

data/lib/tasks/red_base_tasks.rake

@@ -0,0 +1,23 @@
+namespace :red_base do
+
+  namespace :js do
+
+    desc "Collect all the strings which marked for translation from javascript files"
+    task :collect => :environment do
+      `grunt --gruntfile #{RedBase::Engine.root}/lib/tasks/grunt/Gruntfile.js --base #{RedBase::Engine.root}/ nggettext_extract`
+    end
+
+    desc "Compile all the strings which marked for translation in javascript files"
+    task :compile => :environment do
+      `grunt --gruntfile #{RedBase::Engine.root}/lib/tasks/grunt/Gruntfile.js nggettext_compile`
+    end
+
+  end
+end
+
+
+namespace :gettext do
+  def files_to_translate
+    Dir.glob("{app,lib,config,locale}/**/*.{rb ,erb,haml,slim,rhtml,js.erb,handlebars.erb }")
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "red_base"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end