kuppayam 0.1.0

data/app/helpers/image_helper.rb

@@ -0,0 +1,209 @@
+module ImageHelper
+
+  # namify returns the first letters of first name and last name
+  # @examples Basic usage
+  #
+  #   >>> namify("Krishnaprasad Varma")
+  #   => "KV"
+  def namify(name)
+    name.split(" ").map{|x| x.first.capitalize}[0..1].join("")
+  end
+
+  # placeholdit is a helper method used to return placechold.it urls with custom width, height and text
+  # It is quite useful for POC Applications to get started with place holder images while developing views
+  #
+  # @example Without Any Arguments
+  #
+  #   >>> placeholdit()
+  #   "http://placehold.it/60x60&text=<No Image>"
+  #
+  # @example With width, height and custom text
+  #
+  #   >>> placeholdit(width: 120, height: 80, text: "User")
+  #   "http://placehold.it/120x80&text=User"
+  def placeholdit(**options)
+    options.reverse_merge!( width: 60, height:  60, text: "<No Image>" )
+    "http://placehold.it/#{options[:width]}x#{options[:height]}&text=#{options[:text]}"
+  end
+
+  # image_url is a helper method which can be used along with carrier_wave gem
+  # Suppose, you have an object 'user' which has a profile_picture
+  # image_url will return you the system default image url if profile_picture is not set else it will return you the carrier wave url
+  # the convention is that the there is a folder named defaults in /assets which has user-medium.png file
+  # user-medium => user is the class name and medium is the size name
+  # for e.g: if the class name is JackFruit, then:
+  #   the filename which it expect would be /assets/defaults/jackfruit-medium.png
+  #
+  # @example Basic Usage without Image
+  #
+  #   >>> image_url(user, "profile_picture.image.thumb.url")
+  #   "/assets/defaults/user-thumb.png"
+  #
+  # @example Basic Usage with Image
+  #
+  #   >>> image_url(user_with_image, "profile_picture.image.thumb.url")
+  #   "uploads/profile_picture/image/1/thumb_test.jpg"
+  #
+  # @example Advance Usage with Placehold.it Arguments
+  #
+  #   >>> image_url(user, "profile_picture.image.large.url", {width: 40, height: 10, text: "Pic"})
+  #   "/assets/defaults/user-large.png"
+  def image_url(object, method_name, **options)
+    begin
+      url = object.send :eval, method_name
+      raise if url.blank?
+    rescue
+      options.reverse_merge!(size: "small")
+      url = object.respond_to?(:default_image_url) ? object.default_image_url(options[:size]) : "/assets/kuppayam/defaults/default-#{options[:size]}.png"
+    end
+    return url
+  end
+
+  # This method will render the image with required width and height.
+  # The image url will be set to the placeholder url if the object doesn't respond to the image method
+  #
+  # @example Basic Usage without Image
+  #
+  #   >>> display_image(user, "profile_picture.image.thumb.url")
+  #   "<img class=\"\" width=\"100%\" height=\"auto\" src=\"http://placehold.it/100x60&amp;text=&lt;No Image&gt;\" alt=\"100x60&amp;text=&lt;no image&gt;\" />"
+  #
+  # @example Basic Usage with image
+  #
+  #   >>> display_image(user, "profile_picture.image.thumb.url", width: "100%", height:"100%")
+  #   "<img class=\"\" width=\"100%\" height=\"100%\" src=\"http://placehold.it/100x60&amp;text=&lt;No Image&gt;\" alt=\"100x60&amp;text=&lt;no image&gt;\" />"
+  #
+  # @example Advanced Usage with width & height
+  #
+  #   >>> display_image(user_with_image, 'profile_picture.image.large.url', width: "30px", height: "50px", size: "small")
+  #   "<img class=\"\" width=\"30px\" height=\"50px\" src=\"/spec/dummy/uploads/image/profile_picture/1/large_test.jpg\" alt=\"Large test\" />"
+  def display_image(object, method_name, **options)
+    options.reverse_merge!(size: "small")
+    options.reverse_merge!(
+      width: "100%",
+      height: "auto",
+      place_holder: {},
+      class: object.persisted? ? "#{object.id}-#{options[:size]}-image" : ""
+    )
+
+    img_url = image_url(object, method_name, **options)
+    return image_tag(img_url, class: options[:class], width: options[:width], height: options[:height])
+  end
+
+  # @example Basic Usage
+  #
+  #   >>> display_user_image(@user, 'profile_picture.image.thumb.url')
+  #   "<div><div class="rounded" style="width:60px;height:60px;"><img alt="Thumb krishnan" class="" src="/uploads/image/profile_picture/39/thumb_krishnan.jpg" style="width:100%;height:auto;cursor:default;"></div></div>"
+  #
+  # @example Advanced Usage with
+  #
+  #   >>> display_user_image(@user, 'profile_picture.image.thumb.url', width: 100px, height: 100px)
+  #   "<div><div class="rounded" style="width:100px;height:60px;"><img alt="Thumb krishnan" class="" src="/uploads/image/profile_picture/39/thumb_krishnan.jpg" style="width:100%;height:auto;cursor:default;"></div></div>"
+  def display_user_image(user, method_name, **options)
+
+    url_domain = defined?(QAuthRubyCustomer) ? QAuthRubyCustomer.configuration.q_auth_url : ""
+
+    options.reverse_merge!(
+      width: "60px",
+      height: "auto",
+      size: "medium",
+      url_domain: url_domain,
+      place_holder: {},
+      html_options: {}
+    )
+
+    options[:html_options].reverse_merge!(
+      style: "width:100%;height:auto;cursor:#{options.has_key?(:popover) ? "pointer" : "default"};",
+      class: user.persisted? ? "#{user.id}-#{options[:size]}-image" : ""
+    )
+
+    if user.respond_to?(:name)
+      options[:place_holder].reverse_merge!(text: namify(user.name))
+    end
+
+    options[:html_options].reverse_merge!(
+      "data-toggle" => "popover",
+      "data-placement" => "bottom",
+      "title" => user.name,
+      "data-content" => options[:popover] === true ? "" : options[:popover].to_s
+    ) if options[:popover]
+
+    begin
+      image_path = user.send(:eval, method_name)
+      if image_path.starts_with?(:http)
+        url = image_path
+      else
+        url = options[:url_domain] + image_path
+      end
+    rescue
+      url = image_url(user, method_name, **options)
+    end
+
+    content_tag(:div) do
+      content_tag(:div, class: "rounded", style: "width:#{options[:width]};height:#{options[:height]}") do
+        image_tag(url, options[:html_options])
+      end
+    end
+  end
+
+  # Displays the image with a edit button below it
+  # @example Basic Usage
+  #   >>> edit_image(@project, "logo.image.url", edit_url, width: "100px", height: "auto")
+  #   ""
+  def edit_image(object, method_name, edit_url, **options)
+    options.reverse_merge!(
+      remote: true,
+      text: "Change Image",
+      icon: "photo",
+      classes: "btn btn-white btn-block btn-xs mt-10"
+    )
+    img_tag = display_image(object, method_name, **options)
+    btn_display = raw(theme_fa_icon(options[:icon]) + theme_button_text(options[:text]))
+    link_to(img_tag, edit_url, :remote => options[:remote]) +
+    link_to(btn_display, edit_url, :class=>options[:classes], :remote=>options[:remote])
+  end
+
+  # Displays the user image in a rounded frame with a edit button below it
+  # @example Basic Usage
+  #   >>> edit_user_image(@project, "logo.image.url", edit_url, width: "100px", height: "auto")
+  #   ""
+  def edit_user_image(object, method_name, edit_url, **options)
+    options.reverse_merge!(
+      remote: true,
+      text: "Change Image",
+      icon: "photo",
+      classes: "btn btn-default btn-xs mt-10"
+    )
+    img_tag = display_user_image(object, method_name, **options)
+    btn_display = raw(theme_fa_icon(options[:icon]) + theme_button_text(options[:text]))
+    link_to(img_tag, edit_url, :remote => options[:remote]) +
+    link_to(btn_display, edit_url, :class=>options[:classes], :remote=>options[:remote])
+  end
+
+  # Returns new photo url or edit existing photo url based on object is associated with photo or not
+  # @example Basic Usage - User without Image
+  #   >>> upload_image_link(@user, :profile_picture, :admin)
+  #   "/admin/images/new"
+  #
+  # @example Basic Usage - User with Iamge
+  #
+  #   >>> upload_image_link(@user_with_image, :profile_picture, :admin)
+  #   "/admin/images/1/edit"
+  #
+  # @example Basic Usage - Custom Scope
+  #
+  #   >>> upload_image_link(@project, :profile_picture, :customer)
+  #   "/customer/images/new"
+  #   >>> upload_image_link(@project_with_image, :profile_picture, :customer)
+  #   "/customer/images/1/edit"
+  def upload_image_link(object, assoc_name=:photo, scope=:admin, **options)
+    photo_object = nil
+    photo_object =  object.send(assoc_name) if object.respond_to?(assoc_name)
+    #binding.pry
+    if photo_object.present? && photo_object.persisted?
+      url_for([:edit, scope, :image, id: photo_object.id, imageable_id: object.id, imageable_type: object.class.to_s, image_type: photo_object.class.name, account_id: options[:account_id]])
+    else
+      photo_object = object.send("build_#{assoc_name}")
+      url_for([:new, scope, :image, imageable_id: object.id, imageable_type: object.class.to_s, image_type: photo_object.class.name, account_id: options[:account_id]])
+    end
+  end
+end

data/app/helpers/kuppayam_helper.rb

@@ -0,0 +1,72 @@
+module KuppayamHelper
+  
+  # fa_icon('plus')
+  # <i class='fa fa-plus'></i>
+  # theme_fa_icon('plus', 'lg')
+  # <i class='fa fa-plus fa-lg'></i>
+  def fa_icon(icon_text, size="")
+    size_class = %w{lg 2x 3x 4x 5x}.include?(size.strip) ? " fa-#{size.strip}" : ""
+    "<i class='fa fa-#{icon_text}#{size_class}'></i>"
+  end
+
+  # Example
+  #   paginate_kuppayam(@projects, false)
+  #
+  # is equivalent to:
+  # ---------------------------
+  # <div class="cl"></div>
+  # <% if @projects.any? %>
+  #    <%= content_tag :div, :class=>"pull-right" do %>
+  #      <%= paginate @projects, :remote => true %>
+  #    <% end %>
+  # <% end %>
+  # <div class="cl"></div>
+  # ---------------------------
+  def paginate_kuppayam(collection, remote=true)
+    return "" if collection.empty?
+    clear_tag(10) +
+    content_tag(:div, :class=>"pull-right") do
+      paginate(collection, :remote => remote)
+    end +
+    clear_tag(10)
+  end
+
+  # theme_search_form is a helper to create a form to filter the results by entering a search query
+  def search_form_kuppayam(cls, url, **options)
+    options.reverse_merge!(
+      method: :get, 
+      remote: true, 
+      text: "", 
+      param_name: "q",
+      placeholder: "Search ...", 
+      button_text: "Search!", 
+      form_html: {
+          :class=>"pull-right", 
+          :style=>"margin-bottom:0px;"},
+      div_html: {:class=>"input-group"},
+      button_class: "btn btn-primary",
+      text_class: "btn-text"
+    )
+
+    form_for cls.new, 
+            :url => url,
+            :method => options[:method], 
+            :remote=>options[:remote],
+            :html=>options[:form_html] do |f|
+
+      content_tag :div, options[:div_html] do
+        text_field_tag(options[:param_name], options[:text], :class => 'form-control', :placeholder => options[:placeholder]) +
+        content_tag(:span, class: "input-group-btn") do
+          button_tag(type: 'submit', class: options[:button_class]) do
+            raw(fa_icon('search') +
+              content_tag(:span, class: options[:text_class]) do
+                " " + options[:button_text]
+              end)
+          end
+        end
+      end
+
+    end
+  end
+  
+end

data/app/helpers/meta_tags_helper.rb

@@ -0,0 +1,50 @@
+module MetaTagsHelper
+
+  def set_heading(heading)
+    @heading = heading
+  end
+
+  def set_title(title)
+    @title = title
+  end
+
+  def title
+    @title || "Kuppayam | Set Title - TitleHelper"
+  end
+
+  def meta_tags
+    return "" unless @meta_tags
+    @meta_tags.reverse_merge!(
+      "robots" => :all,
+      "viewport" => "width=device-width, initial-scale=1.0",
+      "copyright" => "2015 K P Varma",
+      "content-language" => "en",
+      "resource-type" => "document",
+      "distribution" => "global",
+      "rating" => "general"
+    )
+
+    link_tags_list = []
+    meta_tags_list = []
+
+    {
+      prev: :rel_prev,
+      next: :rel_next,
+      canonical: :canonical
+    }.each do |k, v|
+      link_tags_list << content_tag(:link, "", rel: k, href: v) if @meta_tags[k]
+    end
+
+    {
+      meta_description: :meta_description,
+      meta_keywords: :meta_keywords,
+      keywords: :keywords,
+      robots: :robots
+    }.each do |k, v|
+      meta_tags_list << content_tag(:meta, "", name: k, content: v) if @meta_tags[k]
+    end
+
+    raw(link_tags_list.join(" ") + meta_tags_list.join(" "))
+
+  end
+end

data/app/helpers/navigation_helper.rb

@@ -0,0 +1,17 @@
+module NavigationHelper
+  def nav_active?(name)
+    @nav == name
+  end
+
+  def nav_class(name)
+    nav_active?(name) ? "active" : ""
+  end
+
+  def set_nav(name)
+    @nav = name
+  end
+
+  def current_nav
+    @nav
+  end
+end

data/app/helpers/params_parser_helper.rb

@@ -0,0 +1,48 @@
+module ParamsParserHelper
+  
+  def parse_pagination_params
+    @current_page = params[:page] || "1"
+    @per_page = params[:per_page] || ConfigCenter::Defaults::ITEMS_PER_LIST.to_s
+
+    if @per_page && @per_page.to_i > ConfigCenter::Defaults::MAX_ITEMS_PER_LIST
+      @per_page = ConfigCenter::Defaults::ITEMS_PER_LIST.to_s
+    end
+
+    @offset = (@current_page.to_i - 1) * (@per_page.to_i)
+  end
+
+  # TODO - Check why we need this method
+  def parse_filter_dates(instance_name, start_date_name="start_date", end_date_name="end_date")
+    ## Parsing the date info if any
+    unless params[instance_name][start_date_name].blank?
+     d = params[instance_name][start_date_name] ? (Time.parse(params[instance_name][start_date_name])) : (Date.today - 1.day)
+     @start_date = params[instance_name][:start_date] || (Date.today - 1.day)
+     @start_time = Time.utc(d.year,d.month,d.day,00,00,00)
+    end
+    unless params[instance_name][end_date_name].blank?
+     d = params[instance_name][end_date_name] ? Time.parse(params[instance_name][end_date_name]) : Date.today
+     @end_date = params[instance_name][end_date_name] || Date.today
+     @end_time = Time.utc(d.year,d.month,d.day,23,59,59)
+    end
+  end
+
+  # TODO - Check why we need this method
+  def add_query_params(url, params)
+    parsed_uri = URI(url)
+
+    if parsed_uri.query
+      query_params = URI.decode_www_form(parsed_uri.query)
+    else
+      query_params = []
+    end
+
+    params.each_pair do |k, v|
+      query_params << [k.to_s, v]
+    end
+
+    parsed_uri.query = URI.encode_www_form(query_params)
+    parsed_uri.to_s
+  end
+end
+
+

data/app/helpers/render_helper.rb

@@ -0,0 +1,28 @@
+module RenderHelper
+
+  def render_or_redirect(error, redirect_url, action, notice=nil)
+    respond_to do |format|
+      format.html {
+        if error
+          render action: action
+        else
+          redirect_to redirect_url, notice: notice
+        end
+      }
+      format.js {}
+    end
+  end
+
+  def render_list
+    respond_to do |format|
+      format.html { get_collections and render :index }
+      format.js {}
+    end
+  end
+
+  def render_show
+    respond_to do |format|
+      format.js { render action: :show }
+    end
+  end
+end

data/app/helpers/resource_helper.rb

@@ -0,0 +1,133 @@
+module ResourceHelper
+
+  def index
+    get_collections
+  end
+
+  def show
+    obj = @options[:class].find(params[:id])
+    instance_variable_set("@#{@options[:item_name]}", obj)
+    render_list
+  end
+
+  def new
+    obj = @options[:class].new
+    instance_variable_set("@#{@options[:item_name]}", obj)
+    render_list
+  end
+
+  def edit
+    obj = @options[:class].find(params[:id])
+    instance_variable_set("@#{@options[:item_name]}", obj)
+    render_list
+  end
+
+  def create
+    obj = @options[:class].new
+    obj.assign_attributes(permitted_params)
+    instance_variable_set("@#{@options[:item_name]}", obj)
+    save_resource(obj)
+  end
+
+  def update
+    obj = @options[:class].find(params[:id])
+    obj.assign_attributes(permitted_params)
+    instance_variable_set("@#{@options[:item_name]}", obj)
+    save_resource(obj)
+  end
+
+  def destroy
+    obj = @options[:class].find(params[:id])
+    instance_variable_set("@#{@options[:item_name]}", obj)
+    if obj.can_be_destroyed?
+      obj.destroy
+      get_collections
+      set_flash_message(@options[:messages][:delete], :success)
+      @destroyed = true
+    else
+      set_flash_message("Cannot remove! Remove the dependant data first", :failure)
+      @destroyed = false
+    end
+  end
+
+  private
+
+  def set_navs
+    set_nav(params[:controller])
+  end
+
+  def permitted_params
+    raise "method 'permitted_params' not defined"
+  end
+
+  def default_collection_name
+    params[:controller].split("/").last
+  end
+
+  def default_item_name
+    default_collection_name.singularize.gsub("_", " ")
+  end
+
+  def default_class
+    default_collection_name.singularize.camelize.constantize
+  end
+
+  def default_resource_controller_configuration
+    {
+      collection_name: default_collection_name,
+      item_name: default_item_name,
+      class: default_class,
+      layout: :table,
+      messages: {
+        add: I18n.translate("forms.add", item: default_item_name.titleize),
+        create: I18n.translate("forms.create", item: default_item_name.titleize),
+        update: I18n.translate("forms.update", item: default_item_name.titleize),
+        save: I18n.translate("forms.save", item: default_item_name.titleize),
+        remove: I18n.translate("forms.remove", item: default_item_name.titleize),
+        delete: I18n.translate("forms.delete",item:  default_item_name.titleize)
+      }
+    }
+  end
+
+  def configure_resource_controller
+    if defined?(@options)
+      @options.reverse_merge!(default_resource_controller_configuration)
+    else
+      @options = default_resource_controller_configuration
+    end
+  end
+
+  def prepare_query
+    @relation = @options[:class].where("")
+    if params[:query]
+      @query = params[:query].strip
+      @relation = @relation.search(@query) if !@query.blank?
+    end
+  end
+
+  def get_collections
+    prepare_query
+    objects = @relation.order("created_at desc").page(@current_page).per(@per_page)
+    instance_variable_set("@#{@options[:collection_name]}", objects)
+    unless instance_variable_get("@#{@options[:item_name]}")
+      instance_variable_set("@#{@options[:item_name]}", objects.first)
+    end
+    return true
+  end
+
+  def resource_url(obj)
+    url_for([:admin, obj])
+  end
+
+  def save_resource(obj)
+    obj.save
+    if obj.errors.blank?
+      get_collections if @options[:layout] = :table
+      set_flash_message(@options[:messages][:save], :success) 
+    end
+    action_name = params[:action].to_s == "create" ? "new" : "edit"
+    url = obj.persisted? ? resource_url(obj) : nil
+    render_or_redirect(obj.errors.any?, url, action_name)
+  end
+
+end