underworld 1.0.0

data/lib/generators/underworld/templates/views/create.json.jbuilder.erb

@@ -0,0 +1,3 @@
+json.id @<%= resource.underscore %>.id.to_s
+json.extract! @<%= resource.underscore %><%= fields_as_params %>
+<% fields.each do |name, type| %><% if type == "has_many" %>json.<%= name %> @<%= resource.underscore %>.<%= name %>, :id, :name<% end %><% end %>

data/lib/generators/underworld/templates/views/destroy.json.jbuilder.erb

@@ -0,0 +1 @@
+json.msg t"Items removed successfully.")

data/lib/generators/underworld/templates/views/index.json.jbuilder.erb

@@ -0,0 +1,13 @@
+json.array! @<%= resource.pluralize.underscore %> do |<%= resource.underscore %>|
+  json.id <%= resource.underscore %>.id.to_s
+  json.extract! <%= resource.underscore %><%= fields_as_params %><% fields.each do |name, type| %><% case type
+  when "belongs_to" %>
+  json.<%= name %> do
+    if <%= resource.underscore %>.<%= name %>
+      json.id <%= resource.underscore %>.<%= name %>.id
+      json.name <%= resource.underscore %>.<%= name %>.name
+    end
+  end
+<% when "has_many" %>
+ json.<%= name %> <%= resource.underscore %>.<%= name %>, :id, :name<% end %><% end %>
+end

data/lib/generators/underworld/templates/views/show.json.jbuilder.erb

@@ -0,0 +1,6 @@
+json.id @<%= resource.underscore %>.id.to_s
+json.extract! @<%= resource.underscore %><%= fields_as_params %><% fields.each do |name, type| %>
+<% case type
+when "belongs_to" %>
+json.partial! 'underworld/relations/belongs_to', object: @<%= resource.underscore %>.<%= name %>, :name => :<%= name %>, :fields => [:id, :name]
+<% when "has_many" %>json.<%= name %> @<%= resource.underscore %>.<%= name %>, :id, :name<% end %><% end %>

data/lib/generators/underworld/templates/views/update.json.jbuilder.erb

@@ -0,0 +1,6 @@
+json.id @<%= resource.underscore %>.id.to_s
+json.extract! @<%= resource.underscore %><%= fields_as_params %>
+<% fields.each do |name, type| %><% if type == "has_many" %>json.<%= name %> @<%= resource.underscore %>.<%= name %>, :id, :name
+<% end %><% if type == "belongs_to" %>
+json.partial! 'underworld/relations/belongs_to', object: @<%= resource.underscore %>.<%= name %>, :name => :<%= name %>, :fields => [:id, :name]
+<% end %><% end %>

data/lib/generators/underworld/views_generator.rb

@@ -0,0 +1,57 @@
+module Underworld
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../../app/', __FILE__)
+
+      desc "Copy given views of a resource to the main application"
+      argument :resource_name , type: :string, required: true
+      argument :views_to_copy , type: :array, default: []
+
+      def copy_views
+        if views_to_copy.empty?
+          views = ['index', 'show', 'new', 'edit', 'create', 'update', 'destroy']
+        else
+          views = views_to_copy
+        end
+
+        empty_directory "app/views/#{resources}"
+
+        if views.include? 'index'
+          copy_file 'views/underworld/dashboard/resource/index.html.slim', "app/views/#{resources}/index.html.slim"
+        end
+
+        if views.include? 'show'
+          copy_file 'views/underworld/dashboard/resource/show.html.slim', "app/views/#{resources}/show.html.slim"
+        end
+
+        if views.include? 'new'
+          copy_file 'views/underworld/dashboard/resource/new.html.slim', "app/views/#{resources}/new.html.slim"
+          copy_file 'views/underworld/dashboard/resource/_form.html.slim', "app/views/#{resources}/_form.html.slim"
+        end
+
+        if views.include? 'edit'
+          copy_file 'views/underworld/dashboard/resource/edit.html.slim', "app/views/#{resources}/edit.html.slim"
+          copy_file 'views/underworld/dashboard/resource/_form.html.slim', "app/views/#{resources}/_form.html.slim"
+        end
+
+        if views.include? 'create'
+          copy_file 'views/underworld/dashboard/resource/create.js.erb', "app/views/#{resources}/create.js.erb"
+        end
+
+        if views.include? 'update'
+          copy_file 'views/underworld/dashboard/resource/update.js.erb', "app/views/#{resources}/update.js.erb"
+        end
+
+        if views.include? 'destroy'
+          copy_file 'views/underworld/dashboard/resource/destroy.js.erb', "app/views/#{resources}/destroy.js.erb"
+        end
+      end
+
+      private
+
+      def resources
+        resource_name.underscore.pluralize
+      end
+    end
+  end
+end

data/lib/tasks/docs.rake

@@ -0,0 +1,6 @@
+namespace :docs do
+  desc "Generate the annotated source code document."
+  task :annotated do
+    system 'groc **/*.rb **/*.js **/*.js.coffee README.md -o docs/annotated_source'
+  end
+end

data/lib/tasks/sync.rake

@@ -0,0 +1,9 @@
+namespace :underworld do
+  namespace :sync do
+
+    desc 'Create missing permissions'
+    task :permissions => :environment do
+      Underworld::Discovery::Permissions.create_all_permissions
+    end
+  end
+end

data/lib/tasks/underworld_tasks.rake

@@ -0,0 +1,38 @@
+namespace :underworld do
+  namespace :i18n do
+    desc 'Add all the missing keys to the locale files'
+    task :collect do
+      def merge_recursively(a, b)
+        #puts "Rec: ", a, b
+        return b if a.is_a?(String)
+        a.merge(b) {|key, a_item, b_item| merge_recursively(a_item, b_item) }
+      end
+
+      Dir["#{Rails.root}/tmp/i18n/*"].each do |locale_file|
+        locale = locale_file.split('/')[-1]
+
+        if File.exist? "#{Rails.root}/config/locales/#{locale}.yml"
+          raw_data = File.read("#{Rails.root}/config/locales/#{locale}.yml")
+          locale_data = YAML.load(raw_data)
+        else
+          locale_data = {}
+        end
+
+        Dir["#{Rails.root}/tmp/i18n/#{locale}/*"].each do |key_file|
+          key   = key_file.split('/')[-1]
+          #puts "Key", key
+
+          title = key.split('.')[-1].titleize
+          array = ::I18n.normalize_keys(locale, key, nil)
+          tmp   = array.reverse.inject(title) do |a, n|
+            { n.to_s => a }
+          end
+
+          locale_data = merge_recursively(locale_data, tmp)
+        end
+
+        puts YAML.dump(locale_data)[4..-1]
+      end
+    end
+  end
+end

data/lib/underworld.rb

@@ -0,0 +1,35 @@
+require 'i18n'
+require 'devise'
+require 'turbolinks'
+require 'modernizr-rails'
+require 'model_discovery'
+require 'pundit'
+require 'slim-rails'
+require 'formtastic'
+require 'kaminari'
+require 'amd'
+
+# Underworld Module
+module Underworld
+  autoload :Helpers,      'underworld/helpers/autoload_helper'
+  autoload :Routes,       'underworld/routes'
+  autoload :RouteHelpers, 'underworld/routes'
+  autoload :Liquid,       'underworld/liquid'
+#  autoload :Engine,       'underworld/engine'
+  autoload :Dashboard,    'underworld/dashboard'
+  autoload :Concerns,     'underworld/concerns'
+  autoload :ORM,          'underworld/orm'
+end
+
+require 'underworld/engine'
+#require 'underworld/orm'
+#require 'underworld/concerns'
+#require 'underworld/dashboard'
+require 'underworld/extension'
+require 'underworld/omniauth'
+require 'underworld/i18n'
+#require 'underworld/route'
+require 'underworld/action_dispatch'
+require 'underworld/discovery'
+require 'underworld/fake_assets'
+require 'underworld/version'

data/lib/underworld/action_dispatch.rb

@@ -0,0 +1,3 @@
+class ActionDispatch::Routing::Mapper
+  include Underworld::RouteHelpers
+end

data/lib/underworld/api.rb

@@ -0,0 +1,42 @@
+module Underworld
+  module API
+
+    #autoload UsersAPI, "underworld/api/users_api"
+    #autoload GroupsAPI, "underworld/api/groups_api"
+    #autoload PermissionsAPI, "underworld/api/permissions_api"
+
+    class Base < Grape::API
+
+      def self.setup_api
+
+        # TODO: Allow user to configure this section
+        version 'v1', :vendor => "Codamic"
+        format :json
+        default_format :json
+
+        # TODO: Give this class a logger
+
+        helpers do
+
+          def warden
+            env['warden']
+          end
+
+          def current_user
+            warden.user
+          end
+
+          def authenticated_user
+            if warden.authenticated?
+              return true
+            else
+              error!('401 Unauthorized', 401)
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/underworld/api/groups_api.rb

@@ -0,0 +1,41 @@
+module Underworld
+  module API
+    class GroupsAPI < Grape::API
+
+      resource :groups do
+
+        desc "Return all the groups"
+        get do
+          authenticated_user
+          # TODO: Check for admin user only
+          Underworld::Group.includes(:permissions)
+        end
+
+        delete do
+          authenticated_user
+
+          #if can? :delete, Group
+          #end
+          Group.delete(params[:id].split(","))
+        end
+
+        post do
+          authenticated_user
+
+          permissions = [];
+
+          params[:permissions].each do |perm_string|
+            perm, model = perm_string.split "|"
+            permission = Permission.find_or_create_by_model_and_permission_type(model, perm)
+            permissions << permission
+          end
+
+          Group.create!({
+                          name: params[:name],
+                          permissions: permissions,
+                        })
+        end
+      end
+    end
+  end
+end

data/lib/underworld/api/permissions_api.rb

@@ -0,0 +1,24 @@
+module Underworld
+  module API
+    class PermissionsAPI < Grape::API
+
+      resource :permissions do
+
+        desc "Return all permissions available"
+        get do
+          authenticated_user
+          # TODO: Check for admin user only
+          permissions = []
+
+          Underworld::Engine.models_with_permission.each do |model|
+            model = Object.const_get(model)
+            permissions.concat(model::Permissions.permission_strings(model))
+          end
+
+          permissions
+        end
+      end
+
+    end
+  end
+end

data/lib/underworld/api/root.rb

@@ -0,0 +1,15 @@
+require_dependency "underworld/api/users_api"
+require_dependency "underworld/api/groups_api"
+require_dependency "underworld/api/permissions_api"
+
+module Underworld
+  module API
+    class Root < Grape::API
+
+      mount API::UsersAPI
+      mount API::GroupsAPI
+      mount API::PermissionsAPI
+
+    end
+  end
+end

data/lib/underworld/api/users_api.rb

@@ -0,0 +1,20 @@
+module Underworld
+  module API
+    class UsersAPI < Grape::API
+
+
+      resource :users do
+
+        desc "Return all the users"
+        get do
+          authenticated_user
+          # TODO: Check for admin user only
+          Underworld::User.all
+        end
+
+      end
+
+
+    end
+  end
+end

data/lib/underworld/concerns.rb

@@ -0,0 +1,7 @@
+module Underworld
+  # Underworld Concerns module
+  module Concerns
+  end
+end
+
+require 'underworld/concerns/authorizable'

data/lib/underworld/concerns/authorizable.rb

@@ -0,0 +1,81 @@
+# TODO: This module should be removed
+module Underworld
+  module Concerns
+    # Authorizable modules of Underworld which each resource model should
+    # includes this concern. Without this concern, models can not be authorized
+    module Authorizable
+      extend ActiveSupport::Concern
+
+      # Class methods which will add to model by including
+      # `Underworld::Concerns::Authorizable`
+      module ClassMethods
+        # Default permission hash
+        @@permissions = {
+          index: nil,
+          show: nil,
+          create: nil,
+          update: nil,
+          destroy: nil,
+          ownership: nil,
+        }
+
+        @@only_owner = false
+
+        # Return an array of strings representation of permissions
+        def permission_strings(model)
+          strings = []
+          model_name = model.to_s
+          humanize_name = ActiveModel::Name.new(model).human
+
+          if model.respond_to? :model_name
+            model_name = model.model_name
+            humanize_name = model_name.human
+          end
+
+          @@permissions.each do |key, value|
+            strings << {
+              name: "#{key}|#{model_name}",
+              string: t("underworld.permission_string", action: key.to_s, model: humanize_name)
+            }
+          end
+
+          strings
+        end
+
+        def possible_permissions
+          @@permissions.keys
+        end
+
+        # Define permissions using this method
+        def permissions(*args)
+          args.each do |permission|
+            if permission.class == Symbol
+              if not @@permissions.include? permission
+                @@permission[permission] = nil
+
+              elsif permission.class == Hash
+
+                permission.each do |key, value|
+                  @@permissions[key.to_sym] = value
+                end
+
+              end
+            end
+
+
+          end
+        end
+
+        # This force user to have access to resources which is his.
+        def only_his_objects
+          @@only_owner = true
+        end
+
+        def only_his_objects?
+          @@only_owner
+        end
+
+      end
+    end
+  end
+end

data/lib/underworld/configuration.rb

@@ -0,0 +1,97 @@
+module Underworld
+  # This module contains all the configuration of `Underworld::Engine`
+  # which can be setup in `config/initializer/underworld.rb`
+  module Configuration
+
+    @@modules_to_load = {}
+
+    # Configure logger
+    mattr_accessor :logger do
+      Logger.new(STDOUT)
+    end
+
+    # Dashboard url prefix
+    mattr_accessor :dashboard_namespace do
+      :dashboard
+    end
+
+    # ==> ORM configuration
+    # Load and configure the ORM. Supports :active_record (default) and
+    # :mongoid (bson_ext recommended) by default. Other ORMs may be
+    # available as additional gems.
+    # ORM name to use. either 'active_record' or 'mongoid'
+    mattr_accessor :orm
+
+    def orm=(orm_name)
+      @@orm = orm_name
+      require "devise/orm/#{orm_name}"
+    end
+
+    # We have to move this method somewhere else
+    def collect_i18n_missing_keys=(value)
+      if value
+        ::I18n.exception_handler = Underworld::I18n::MissingKeyHandler.new
+      end
+    end
+
+    mattr_accessor :i18n_debug do
+      false
+    end
+
+    # Site Title
+    attr_accessor :site_title do
+      'Underworld'
+    end
+
+    mattr_accessor :slug
+
+    # Dashboard default javascript manifest
+    mattr_accessor :dashboard_js_manifest do
+      'dashboard/application.js'
+    end
+
+    # Devise options
+    # Include default devise modules. Others available are:
+    # :token_authenticatable, :confirmable,
+    # :lockable, :timeoutable and :omniauthable
+    mattr_accessor :devise_options do
+      [:database_authenticatable, :registerable,
+        :recoverable, :rememberable, :trackable,
+        :lockable, :timeoutable, :validatable]
+    end
+
+    mattr_accessor :devise_for do
+      {}
+    end
+
+    # Whether using UUID with models or not.
+    mattr_accessor :use_uuid do
+      false
+    end
+
+    mattr_accessor :amd_dir do
+      'amd'
+    end
+
+    mattr_accessor :amd do
+      true
+    end
+    # This hash map contains all the features as keys and
+    # the required dependencies of each feature in form of
+    # an array as value
+    @@modules_to_load[:amd] = ['amd']
+
+    # Load all the features dependencies based on their configuration
+    # value. For example if `amd` class method returns true all of its
+    # dependencies will be loaded.
+    def load_dependencies_based_on_configuration
+      @@modules_to_load.each do |k, v|
+        v.map { |mod| require mod } if send(k)
+      end
+    end
+
+    def enabled?(configuration)
+      @@modules_to_load.include? configuration
+    end
+  end
+end