corn_starch 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d4001684c8aec6790729b78f98fe2041f6cfa07
-  data.tar.gz: 0929797b47e69c9b3a03f34faea799dc6712936f
+  metadata.gz: ae61e1aad76f9b55fd99ea16106e38398adb03c5
+  data.tar.gz: 2f7d494416ea0bfc2eb04610a2987c6824d620ff
 SHA512:
-  metadata.gz: 208715b6f04eceecd229dd9193c02cc0eee07e288858b70c1d703528366924e77de2c5ba6ab549209198fb12ec89c07a3f437a7343313ea1ee72f8545701eeaa
-  data.tar.gz: a68231b3c3efa8b9fe3df5bab910a7620d769ca53aec9c6d26e7f048821ce0c28aed1153f52ef73a28928cff020f07b1233568b9ba16dbc48e01e9e7ca4d77ab
+  metadata.gz: e6a2903646cd540dc3b1878987b13b0294309cab0aec362488d8d945087dd7911abf8a1d2b1752251ed71a2bf49e78465c7a9e39994c933fe4da411636ff98de
+  data.tar.gz: 6f613a83818a11c1513a68bcffbceee28d853b046bb32d59b47a9fec8215622b66e99b31e8db1261e66ef44aabb3247700d40fd45dd53b0462353bb47723e926

data/app/controllers/application_controller.rb

@@ -0,0 +1,200 @@
+# CornStarch
+# by Eresse <eresse@eresse.net>
+
+# CornStarch Module
+module CornStarch
+
+	# Application Controller
+	class ApplicationController < ActionController::Base
+
+		# CSRF Protection
+		protect_from_forgery with: :exception
+
+		# Global Filters
+		before_filter :pagination_filter
+
+		# Helper Methods
+		helper_method :user_model, :current_user, :is_authed, :is_self, :paginate, :notice_msg
+
+		####################
+		# Controller Utils #
+		####################
+
+		# Universal Search
+		def unisearch model, search
+
+			# Initialize Variables
+			search_model = model
+			search_q = ''
+			search_a = []
+			search_fields = {}
+
+			# Run through Model's Associations
+			model.searchable_associations.each do |a|
+
+				# Join into Search Model
+				search_model = search_model.includes a
+
+				# Acquire Association Target Model
+				assoc = model.reflect_on_association(a).klass
+
+				# Add Target Model's Search Fields
+				search_fields[assoc.table_name] = assoc.searchable_attributes
+			end
+
+			# Add Base Model's Search Fields
+			search_fields[model.table_name] = []
+			model.searchable_attributes.each { |a| search_fields[model.table_name] << a }
+
+			# Run through Search Fields Models
+			search_fields.each do |m|
+
+				# Run through Model's Fields
+				m.each do |f|
+
+					# Build Search Query & Arguments Array
+					search_q = search_q + "#{m}.#{f} LIKE ? "
+					search_a << "%#{search}%"
+				end
+			end
+
+			# Perform Search and eliminate doubles
+			search_model.where(search_q, *search_a).references(model.table_name).uniq
+		end
+
+		# Private
+		private
+
+		##################
+		# Filter Methods #
+		##################
+
+		# Authentication Filter
+		def auth_filter
+			redirect_to new_session_url, alert: { head: t('corn_starch.auth.access_denied'), body: t('corn_starch.auth.login_required') } unless is_authed
+		end
+
+		# Un-Authentication Filter
+		def unauth_filter
+			redirect_to root_url, alert: { head: t('corn_starch.auth.access_denied'), body: t('corn_starch.auth.already_logged_in') } if is_authed
+		end
+
+		# Self Filter
+		def self_filter
+			redirect_to root_url, alert: { head: t('corn_starch.auth.access_denied'), body: t('corn_starch.auth.invalid_user_id') } unless is_self
+		end
+
+		# Not Self Filter
+		def not_self_filter
+			redirect_to root_url, alert: { head: t('corn_starch.auth.access_denied'), body: t('corn_starch.auth.invalid_user_id') } if is_self
+		end
+
+		# Pagination Filter
+		def pagination_filter
+
+			# Set Records Per Page from Request Arguments
+			session[:pagination][:recs_per_page] = params[:records_per_page].to_i if params[:records_per_page]
+
+			# Init Pagination Vars
+			@pagination[:current] = 0
+			@pagination[:links] = []
+			@pagination[:pg_count] = 0
+
+			# Acquire Records per Page from Session / Configuration
+			@pagination[:recs_per_page] = (session[:pagination][:recs_per_page] || CORNSTARCH_CONF['pagination']['records_per_page']['default']).to_i
+		end
+
+		##################
+		# Helper Methods #
+		##################
+
+		# User Model
+		def user_model
+			Kernel.const_get CORNSTARCH_CONF['authentication']['user_model']['name']
+		end
+
+		# UID Field
+		def uid_field
+			CORNSTARCH_CONF['authentication']['user_model']['uid_field']
+		end
+
+		# Current User
+		def current_user
+			@current_user ||= user_model.find(session[:user_id]) if session[:user_id]
+		end
+
+		# Is Authed
+		def is_authed
+			current_user != nil
+		end
+
+		# Is Self
+		def is_self
+			return false unless current_user
+			params[:id] == current_user.id.to_s
+		end
+
+		# Paginate
+		def paginate collection, params
+
+			# Acquire Current Page
+			current = (params[:current_page] || 0).to_i
+
+			# Compute Page Count
+			total = collection.count
+			@pagination[:pg_count] = (total / @pagination[:recs_per_page]) + (((total % @pagination[:recs_per_page]) > 0) ? 1 : 0)
+
+			# Compute Page Range
+			range_start = current - (CORNSTARCH_CONF['pagination']['page_range'] / 2)
+			range_start = 0 if range_start < 0
+			range_end = current + (CORNSTARCH_CONF['pagination']['page_range'] / 2)
+			range_end = @pagination[:pg_count] - 1 if range_end >= @pagination[:pg_count]
+
+			# Create Page Links
+			@pagination[:links] = range_start .. range_end
+			@pagination[:current] = current
+
+			# Fetch Records
+			collection.limit(@pagination[:recs_per_page]).offset current * @pagination[:recs_per_page]
+		end
+
+		# Generic Notice Messages
+		def notice_msg model, entity, action, result_or_name
+
+			# Prepare Names
+			uname = current_user ? current_user.username : ''
+			ename = entity ? entity.display_name : ''
+
+			# Switch on Action
+			case action
+
+				# Session Control
+				when :login
+					{
+						pass: { head: t('corn_starch.gen_msg.login.pass.head'), body: t('corn_starch.gen_msg.login.pass.body', name: uname) },
+						fail: { head: t('corn_starch.gen_msg.login.fail.head'), body: t('corn_starch.gen_msg.login.fail.body') }
+					}[result_or_name]
+				when :logout
+					{ head: t('corn_starch.gen_msg.logout.head'), body: t('corn_starch.gen_msg.logout.body') }
+
+				# Generic Resources
+				when :create
+					{
+						pass: { head: t('corn_starch.gen_msg.create.pass.head', model: model), body: t('corn_starch.gen_msg.create.pass.body', model: model, name: ename) },
+						fail: { head: t('corn_starch.gen_msg.create.fail.head', model: model), body: t('corn_starch.gen_msg.create.fail.body') }
+					}[result_or_name]
+				when :update
+					{
+						pass: { head: t('corn_starch.gen_msg.update.pass.head', model: model), body: t('corn_starch.gen_msg.update.pass.body', model: model, name: ename) },
+						fail: { head: t('corn_starch.gen_msg.update.fail.head', model: model), body: t('corn_starch.gen_msg.update.fail.body') }
+					}[result_or_name]
+				when :destroy
+					{ head: t('corn_starch.gen_msg.destroy.head', model: model), body: t('corn_starch.gen_msg.destroy.body', model: model, name: result_or_name) }
+
+				# Error
+				else
+					t('corn_starch.gen_msg.unknown_action', action: action)
+			end
+		end
+	end
+end

data/app/controllers/sessions_controller.rb

@@ -0,0 +1,36 @@
+# CornStarch
+# by Eresse <eresse@eresse.net>
+
+# CornStarch Module
+module CornStarch
+
+	# Sessions Controller
+	class SessionsController < ApplicationController
+
+		# Filters
+		skip_before_filter :auth_filter, only: [:new, :create]
+		before_filter :unauth_filter, only: [:new, :create]
+
+		# New (Login)
+		def new
+		end
+
+		# Create (Login)
+		def create
+			@user = user_model.find_by uid_field => params[uid_field]
+			if @user && @user.authenticate(params[:password])
+				session[:user_id] = @user.id
+				redirect_to root_url, notice: notice_msg(nil, nil, :login, :pass)
+			else
+				flash.now[:alert] = notice_msg(nil, nil, :login, :fail)
+				render action: :new
+			end
+		end
+
+		# Drop (Logout)
+		def drop
+			session[:user_id] = nil
+			redirect_to root_url, notice: notice_msg(nil, nil, :logout, nil)
+		end
+	end
+end

data/app/helpers/corn_starch/corn_starch_helper.rb

@@ -11,9 +11,49 @@ module CornStarch
 		extend ActionView::Helpers
 		extend ActionView::Context
 
-		# Include Stylesheets
-		def self.corn_starch_resource_tags
-			stylesheet_link_tag('bootstrap.min') + javascript_include_tag('bootstrap.min')
+		# Class Masher
+		def class_mash base, classes
+			class_s = base
+			if classes.respond_to? :each
+				classes.each { |c| class_s += " #{base}-#{c}" }
+			else
+				class_s += " #{base}-#{classes}"
+			end
+			class_s
+		end
+
+		# Glyph Icon
+		def glyphicon_tag icon_class
+			span_tag nil, class: class_mash(:glyphicon, icon_class), 'arya-hidden': true
+		end
+
+		# Label
+		def lbl_tag label_class, content, icon = nil
+			span_tag nil, class: class_mash(:label, label_class) do
+				icon ? glyphicon_tag(icon) + ' ' + content : content
+			end
+		end
+
+		# Button Link
+		def btn_link_to btn_class, target, name = nil, icon = nil, options = {}
+			link_to target, options do
+				button_tag class: class_mash(:btn, btn_class) do
+					block_given? ? yield : (icon ? glyphicon(icon) + ' ' + name : name)
+				end
+			end
+		end
+
+		# Missing Method Handler
+		def method_missing name, *args, &block
+
+			# Handle Generic Tag
+			if name.to_s =~ /(.*)_tag/
+				content_tag $1.to_sym, *args, &block
+
+			# Default
+			else
+				super
+			end
 		end
 	end
-end
+end

data/app/views/corn_starch/layouts/_notifications.html.erb

@@ -0,0 +1,7 @@
+<!-- Display Flash Notifications -->
+<% flash.each do |name, msg| %>
+	<%= content_tag :div, class: "alert alert-#{{ notice: 'success', alert: 'danger' }[name.to_sym]}", role: :alert do %>
+		<strong><%= msg['head'] %></strong>
+		<p><%= msg['body'] %></p>
+	<% end %>
+<% end %>

data/app/views/corn_starch/layouts/_pagination.html.erb

@@ -0,0 +1,21 @@
+<!-- Page Links -->
+<nav>
+	<%= ul_tag class: :corn_starch_pagination do %>
+		<%= li_tag link_to('<<', current_page: 0) %>
+		<% @pagination[:links].each do |p| %>
+			<%= li_tag link_to(p, (p == @pagination[:current] ? '#' : {current_page: p})), class: (p == @pagination[:current] ? :active : '') %>
+		<% end %>
+		<%= li_tag link_to('>>', current_page: @pagination[:pg_count] - 1) %>
+	<% end %>
+</nav>
+
+<!-- Records per Page Selector -->
+<form method='get' action='' class='form-inline'>
+	<div class='form-group'>
+		<%= label_tag :records_per_page, 'Records per page', class: 'control-label' %>
+		<div class='input-group'>
+			<%= select_tag :records_per_page, options_for_select(CORNSTARCH_CONF['pagination']['records_per_page']['opts'], @pagination[:recs_per_page]), class: 'form-control' %>
+		</div>
+	</div>
+	<%= submit_tag 'Go', name: nil, class: 'btn btn-primary' %>
+</form>

data/config/initializers/corn_starch_config.rb

@@ -0,0 +1,33 @@
+# CornStarch
+# by Eresse <eresse@eresse.net>
+
+# CornStarch Configuration Initializer
+
+# Includes
+require 'rubygems'
+require 'yaml'
+require 'json'
+
+# Load up Configuration
+CORNSTARCH_CONF = {}
+CORNSTARCH_CONF_FILE = "#{Rails.root}/config/corn_starch.yml"
+CORNSTARCH_CONF = YAML::load_file CORNSTARCH_CONF_FILE if File.exist? CORNSTARCH_CONF_FILE
+
+######################
+# Configure Defaults #
+######################
+
+# Base Style
+CORNSTARCH_CONF['base_style'] ||= 'bootstrap'
+
+# Pagination
+CORNSTARCH_CONF['pagination'] ||= {}
+CORNSTARCH_CONF['pagination']['page_range'] ||= 6
+CORNSTARCH_CONF['pagination']['records_per_page'] ||= {}
+CORNSTARCH_CONF['pagination']['records_per_page']['default'] ||= 10
+CORNSTARCH_CONF['pagination']['records_per_page']['opts'] ||= [ 10, 25, 50, 100 ]
+
+# Authentication
+CORNSTARCH_CONF['authentication'] ||= {}
+CORNSTARCH_CONF['authentication']['user_model']['name'] = 'User'
+CORNSTARCH_CONF['authentication']['user_model']['uid_field'] = 'username'

data/config/locales/en.yml

@@ -0,0 +1,58 @@
+# CornStarch
+# by Eresse <eresse@eresse.net>
+
+# English Translations
+en:
+
+  # CornStarch Strings
+  corn_starch:
+
+    # Auth
+    auth:
+      access_denied: "Access denied"
+      login_required: "Login required"
+      already_logged_in: "Already logged in"
+      invalid_user_id: "Invalid user ID"
+
+    # Generic Notice Messages
+    gen_msg:
+
+      # Login
+      login:
+        pass:
+          head: "Logged in"
+          body: "You have successfully logged in as %{name}"
+        fail:
+          head: "Login failed"
+          body: "Invalid username / password"
+
+      # Logout
+      logout:
+        head: "Logged out"
+        body: "You have successfully logged out"
+
+      # Create
+      create:
+        pass:
+          head: "%{model} created"
+          body: "%{model} [%{name}] was successfully created"
+        fail:
+          head: "%{model} creation failed"
+          body: "Invalid information"
+
+      # Update
+      update:
+        pass:
+          head: "%{model} updated"
+          body: "%{model} [%{name}] was successfully updated"
+        fail:
+          head: "%{model} update failed"
+          body: "Invalid information"
+
+      # Destroy
+      destroy:
+        head: "%{model} destroyed"
+        body: "%{model} [%{name}] was successfully destroyed"
+
+      # Unknown Action
+      unknown_action: "Unknown action [%{action}]"

data/config/locales/fr.yml

@@ -0,0 +1,51 @@
+# CornStarch
+# by Eresse <eresse@eresse.net>
+
+# French Translations
+fr:
+
+  # CornStarch Strings
+  corn_starch:
+
+    # Generic Notice Messages
+    gen_msg:
+
+      # Login
+      login:
+        pass:
+          head: ""
+          body: ""
+        fail:
+          head: ""
+          body: ""
+
+      # Logout
+      logout:
+        head: ""
+        body: ""
+
+      # Create
+      create:
+        pass:
+          head: ""
+          body: ""
+        fail:
+          head: ""
+          body: ""
+
+      # Update
+      update:
+        pass:
+          head: ""
+          body: ""
+        fail:
+          head: ""
+          body: ""
+
+      # Destroy
+      destroy:
+        head: ""
+        body: ""
+
+      # Unknown Action
+      unknown_action: ""