aerogel-core 1.3.0 → 1.4.10

data/lib/aerogel/core/application.rb

@@ -8,6 +8,8 @@ require 'aerogel/core/assets'
 require 'aerogel/core/db'
 require 'aerogel/core/render'
 require 'aerogel/core/errors'
+require 'aerogel/core/i18n'
+require 'aerogel/core/cache'
 
 class Aerogel::Application < Sinatra::Base
 
@@ -35,4 +37,5 @@ Aerogel.on_load do |app|
   app.register Aerogel::Assets
   app.register Aerogel::Db
   app.register Aerogel::Render
+  app.register Aerogel::I18n
 end

data/lib/aerogel/core/assets.rb

@@ -1,3 +1,5 @@
+require 'sprockets-sass'
+require 'sass'
 require 'sinatra/asset_pipeline'
 
 module Aerogel::Assets
@@ -5,6 +7,28 @@ module Aerogel::Assets
   # Registers and configures assets pipeline
   #
   def self.registered( app )
+    setup_reloader(app) if Aerogel.config.aerogel.reloader?
+    setup_assets_pipeline app
+  end
+
+  # Configures reloader for assets.
+  #
+  def self.setup_reloader(app)
+    app.use Aerogel::Reloader, :routes, after: true do
+      reset!(app)
+      setup_assets_pipeline( app )
+    end
+  end
+
+  # Resets assets pipeline
+  #
+  def self.reset!(app)
+    # TODO how to remove middleware? anyone?
+  end
+
+  # Configures assets pipeline.
+  #
+  def self.setup_assets_pipeline( app )
     # Include these files when precompiling assets
     app.set :assets_precompile,
       %w(application.js controllers/*.js application.css controllers/*.css) +

data/lib/aerogel/core/cache.rb

@@ -0,0 +1,72 @@
+# Aerogel::Cache implements LRU cache storage for partials (or other data?) caching.
+#
+
+require 'lru_redux'
+
+module Aerogel
+module Cache
+
+  # Calculates a cache key for a single object,
+  # or a compound cache key for a list of objects.
+  #
+  def self.cache_key( args )
+    if Array === args
+      args.flatten.map{|o| object_to_cache_key o }.join("/")
+    else
+      object_to_cache_key args
+    end
+  end
+
+  # Retrieves cache entry by calculated cache key of +args+,
+  # or runs given +block+, stores its result in the cache and returns its value.
+  #
+  def self.cacheable( *args, &block )
+    key = cache_key args
+    cache.getset key do
+      yield key
+    end
+  end
+
+  # Returns cache structure.
+  #
+  def self.cache
+    @cache ||= initialize_cache
+  end
+
+  # Returns list of stored keys.
+  #
+  def self.keys
+    cache.to_a.map(&:first)
+  end
+
+  # Clears cache completely.
+  #
+  def self.clear!
+    @cache.clear
+  end
+
+private
+
+  # Creates LRU cache with maximum objects count
+  # specified by config value 'aerogel.cache.max_size'.
+  #
+  def self.initialize_cache
+    max_size = Aerogel.config.aerogel.cache.max_size! rescue 1000
+    LruRedux::Cache.new( max_size )
+  end
+
+  # Calculates a cache key for given +object+.
+  #
+  # If the object responds to :cache_key, its result is returned,
+  # otherwise cache key is the object converted to String.
+  #
+  def self.object_to_cache_key( object )
+    if object.respond_to? :cache_key
+      object.cache_key
+    else
+      object.to_s
+    end
+  end
+
+end # module Cache
+end # module Aerogel

data/lib/aerogel/core/config.rb

@@ -1,5 +1,6 @@
 require 'aerogel/configurator'
 require 'rack-flash'
+require 'sinatra/redirect_with_flash'
 require 'sinatra/multi_route'
 
 module Aerogel
@@ -28,11 +29,18 @@ module Aerogel
 
       # set :protection, true
       # set :protect_from_csrf, true
-      app.set :sessions, true
+      app.enable :sessions
+      if Aerogel.config.hostname?
+        app.set :sessions, domain: "."+Aerogel.config.hostname!
+      end
       # TODO: demand to configure session secret on application level
-      # set :session_secret, '$aer0G31'
+      if Aerogel.config.session_secret?
+        app.set :session_secret, Aerogel.config.session_secret!
+      end
+
       app.use Rack::Protection::AuthenticityToken
       app.use Rack::Flash, :sweep => true
+      app.helpers Sinatra::RedirectWithFlash
 
       app.register Sinatra::MultiRoute
     end

data/lib/aerogel/core/core.rb

@@ -1,3 +1,7 @@
+require 'active_support/core_ext'
+require 'aerogel/core/core_ext/array'
+require 'aerogel/core/core_ext/hash'
+
 module Aerogel
 
   class << self
@@ -7,7 +11,7 @@ module Aerogel
   # Returns module version.
   #
   def self.version
-    Aerogel::VERSION
+    Aerogel::Core::VERSION
   end
 
   # Registers a new path for all resource loaders.
@@ -20,7 +24,9 @@ module Aerogel
   #
   def self.register_path( path, type = nil )
     @registered_paths ||= []
-    @registered_paths << { path: File.expand_path( path ), type: type }
+    path = File.expand_path( path )
+    module_name = File.basename path
+    @registered_paths << { path: path, module_name: module_name, type: type }
   end
 
   # Returns registered paths.
@@ -32,15 +38,54 @@ module Aerogel
 
   # Returns list of paths for specified resource type.
   #
-  def self.get_resource_paths( type )
-    registered_paths( type ).map do |p|
-      p[:type].nil? ? File.join( p[:path], type.to_s ) : p[:path]
+  def self.get_resource_paths( type, &block )
+    paths = []
+    registered_paths( type ).each do |base_path|
+      path = base_path[:type].nil? ? File.join( base_path[:path], type.to_s ) : base_path[:path]
+      paths << { base_path: base_path, path: path }
+      yield path, base_path if block_given?
     end
+    paths.map {|p| p[:path] }
   end
 
   # Returns list of filenames of resources of specified type,
   # environment sub-folders included, filtered by wildcard mask.
   #
+  # Resources are listed in a forward order of paths, files within each
+  # path listed in alphabetic order.
+  #
+  # The resources are searched in following order:
+  #   path1 + wildcard
+  #   path1 + environment + wildcard
+  #   path2 + wildcard
+  #   path2 + environment + wildcard
+  #   etc
+  #
+  def self.get_resource_list( type, wildcard, environment = nil, &block )
+    resource_list = []
+    get_resource_paths( type ) do |path, base_path|
+      paths = Dir.glob( File.join( path, wildcard ) ).sort
+      if environment
+        paths << Dir.glob( File.join( path, environment.to_s, wildcard ) ).sort
+      end
+      # puts "Aerogel::get_resource_list: type=#{type} environment=#{environment} path=#{path}: #{paths}"
+      if block_given?
+        paths.each do |filename|
+          relative_filename = filename.sub( /^#{path}\/?/, '' )
+          yield filename, relative_filename, path, base_path
+        end
+      end
+      resource_list << paths
+    end
+    resource_list.flatten
+  end
+
+  # Returns reversed list of filenames of resources of specified type,
+  # environment sub-folders included, filtered by wildcard mask.
+  #
+  # Reverse order is applied to registered paths, but not to files within single path,
+  # which are listed in alphabetic order.
+  #
   # The resources are searched in following order:
   #   path1 + wildcard
   #   path1 + environment + wildcard
@@ -48,11 +93,11 @@ module Aerogel
   #   path2 + environment + wildcard
   #   etc
   #
-  def self.get_resource_list( type, wildcard, environment = nil )
-    get_resource_paths( type ).map do |path|
-      paths = Dir.glob( File.join( path, wildcard ) )
+  def self.get_reverse_resource_list( type, wildcard, environment = nil )
+    get_resource_paths( type ).reverse.map do |path|
+      paths = Dir.glob( File.join( path, wildcard ) ).sort
       if environment
-        paths << Dir.glob( File.join( path, environment.to_s, wildcard ) )
+        paths << Dir.glob( File.join( path, environment.to_s, wildcard ) ).sort
       end
       # puts "Aerogel::get_resource_list: type=#{type} environment=#{environment} path=#{path}: #{paths}"
       paths
@@ -82,7 +127,7 @@ module Aerogel
   # Require resources specified by type and wildcard in reverse order.
   #
   def self.require_resources_reverse( type, wildcard, environment = nil )
-    files_to_require = Aerogel.get_resource_list( type, wildcard, environment ).reverse
+    files_to_require = Aerogel.get_reverse_resource_list( type, wildcard, environment )
     files_to_require.each do |filename|
       # begin
         require filename

data/lib/aerogel/core/core_ext/array.rb

@@ -0,0 +1,38 @@
+#
+# Core extensions to Array.
+#
+
+class Array
+
+  # Returns array with excluded elements.
+  #
+  def except( *args )
+    self - [ *args ]
+  end
+
+  # Modifies and returns array with excluded elements.
+  #
+  def except!( *args )
+    self.replace( self.except! *args )
+  end
+
+  # Returns array containing only elements listed in +args+.
+  #
+  def only( *args )
+    self & [*args]
+  end
+
+  # Modifies and returns array containing only elements listed in +args+.
+  #
+  def only!( *args )
+    self.replace( self.only *args )
+  end
+
+  # Returns +true+ if this array contains +other+ completely.
+  #
+  def contains?( other )
+    ( other - self ).blank?
+  end
+
+
+end # class Array

data/lib/aerogel/core/core_ext/hash.rb

@@ -0,0 +1,48 @@
+#
+# Core extensions to Hash.
+#
+
+class Hash
+
+  # defined in ActiveSupport: #except, #except!
+
+  # Returns hash containing only elements listed in +args+.
+  #
+  def only( *keys )
+    self.select{|key,v| [*keys].include? key }
+  end
+
+  # Modifies and returns hash containing only elements listed in +args+.
+  #
+  def only!( *keys )
+    self.select!{|key,v| [*keys].include? key }
+    self
+  end
+
+  # Returns hash containing all elements except those with specified +keys+.
+  #
+  def except( *keys )
+    dup.except!( *keys )
+  end
+
+  # Modifies and returns hash containing all elements except those with specified +keys+.
+  #
+  def except!( *keys )
+    keys.each do |k|
+      if String === k || Symbol === k
+       delete k.to_sym
+       delete k.to_s
+      else
+        delete k
+      end
+    end
+    self
+  end
+
+  # Returns Hash converted to a string of HTML tag attributes.
+  #
+  def to_html_params
+    self.map{|n, v| v.nil? ? "#{n}" : "#{n}=\"#{v}\""}.join(" ")
+  end
+
+end # class Array

data/lib/aerogel/core/db.rb

@@ -1,4 +1,5 @@
 require 'mongoid'
+require 'mongoid/tree'
 require 'aerogel/configurator'
 require 'aerogel/core/db/model'
 
@@ -41,6 +42,11 @@ module Aerogel::Db
   #
   def self.clear!
     puts "* clearing database"
+    models.each do |model_class|
+      puts "** destroing all objects in #{model_class.name}"
+      model_class.destroy_all
+    end
+    puts "* purging database"
     Mongoid.purge!
   end
 
@@ -56,10 +62,11 @@ private
   #
   def self.load_models
     reset!
-    Aerogel.get_resource_list( 'db/model', '*.rb' ).each do |model_filename|
-      load model_filename
-      class_name = File.basename( model_filename, '.rb' ).camelize
-      self.models << eval(class_name)
+    Aerogel.get_resource_list( 'db/model', '**/*.rb' ) do |full_filename, model_filename, path|
+      # puts "** loading model: #{path} #{model_filename}"
+      load full_filename
+      # puts "** classify: #{class_name}"
+      self.models << filename_to_model( model_filename )
     end
   end
 
@@ -68,8 +75,8 @@ private
   def self.reset!(app = nil)
     self.models ||= []
     # reset model classes
-    self.models.each do |model|
-      Object.send(:remove_const, model.name.to_sym)
+    self.models.uniq.each do |model|
+      model.parent.send(:remove_const, model.name.demodulize.to_sym)
     end
     self.models = []
   end
@@ -78,7 +85,9 @@ private
   # Configures reloader for models.
   #
   def self.setup_reloader(app)
-    app.use Aerogel::Reloader, ->{ Aerogel.get_resource_list( "db/model", "*.rb" ) } do
+    app.use Aerogel::Reloader,
+    ->{ Aerogel.get_resource_list( "db/model", "**/*.rb" ) },
+    group: :'db/model' do
       reset!(app)
       load_models
     end
@@ -99,7 +108,12 @@ private
   def self.load_and_process_seeds!
     seed_files = Aerogel.get_resource_list( 'db/seed', '*.seed', environment )
     seed_files.each do |seed_file|
-      load_and_process_single_seed! seed_file
+      begin
+        load_and_process_single_seed! seed_file
+      rescue => e
+        puts "!!! Failed to process seed: #{seed_file}"
+        puts "!!! #{e}"
+      end
     end
   end
 
@@ -148,5 +162,11 @@ private
     obj_keys.map{|k,v| "#{k}:'#{v}'"}.join(', ')
   end
 
+  # Returns class object inferred from filename.
+  #
+  def self.filename_to_model( filename )
+    filename.chomp('.rb').split("/").map(&:camelize).join("::").constantize
+  end
+
 end # module Aerogel::Db
 

data/lib/aerogel/core/db/model.rb

@@ -3,22 +3,54 @@
 module Model
   extend ActiveSupport::Concern
 
-  included do
-    include Mongoid::Document
+  def self.redefined_field_types
+    @redefined_field_types ||= {}
+  end
+
+  def self.define_field_type( type, method_name )
+    redefined_field_types[type] = method_name.to_sym
+  end
+
+  module ClassMethods
 
     # Finds document by id.
     # Raises error if document is not found.
     #
-    def self.find!( *args )
+    def find!( *args )
       raise_not_found_error_was = Mongoid.raise_not_found_error
       begin
         Mongoid.raise_not_found_error = true
-        self.find *args
+        self.find( *args )
       ensure
         Mongoid.raise_not_found_error = raise_not_found_error_was
       end
     end
 
+    # ...
+    # other class methods can be defined inside Model::ClassMethods by aerogel modules
+    # ...
+
+  end # module ClassMethods
+
+  included do
+    include Mongoid::Document
+
+    class << self
+      alias_method :define_field_mongoid, :field
+    end
+
+    # Defines native Mongoid field or calls field type handler
+    # in case of redefined field types.
+    #
+    def self.field( name, opts = {} )
+      if opts[:type] && Model.redefined_field_types.key?( opts[:type] )
+        self.send Model.redefined_field_types[opts[:type]], name, opts
+      else
+        self.define_field_mongoid( name, opts )
+      end
+    end
+
+    extend ClassMethods
   end
 
   module NonPersistent
@@ -31,4 +63,20 @@ module Model
     end
   end # module NonPersistent
 
+  module Timestamps
+    extend ActiveSupport::Concern
+    included do
+      include Mongoid::Timestamps
+    end
+  end # module Timestamps
+
+  module OrderedTree
+    extend ActiveSupport::Concern
+    included do
+      include Mongoid::Tree
+      include Mongoid::Tree::Ordering
+      include Mongoid::Tree::Traversal
+    end
+  end # module OrderedTree
+
 end # module Model