site_framework 3.2.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dd432879717df455aa88d8810bc7b780604aa75
-  data.tar.gz: 5a8a32c23640602f22a4c1c2938203dd30f68d55
+  metadata.gz: 62be8f127063701148dbaea74352fe781c1f78a2
+  data.tar.gz: 39437c595f044e4a4ef5d6733b5178fa678b464c
 SHA512:
-  metadata.gz: 494d692503b3babe939086aa847519ad088a01ac602b3a1a6338a8658017d16028b673eef5d713347efef8c901cbb56c90a1a9ca332451d1adf88878a8e5a78a
-  data.tar.gz: 6e4ad4624bcd118347be5eae135b56cf4228916ca9c844fa7af526874bbcb69fc5d9becc435e7a8c9e697baeed88e586c0de8fbe8c9dbed73746fc0946b8e9fb
+  metadata.gz: a9e3ca92919e98c4db6a46a08aaafc54045ef7ddf5192b2c74389b1222510f729b57fe418e9f138262ae7964e40f3bc9d001054af753dd8a4ac2824326257198
+  data.tar.gz: 8a51d6565a1b2725fa0bcad57cab31f213119c7c12d235a5728c6dd9eab37c14a5673c23a2dd886b28d672232cd820c5e2e60debc4f0c10b26e1827f0671ee1a

data/README.md

@@ -82,6 +82,23 @@ end
 
 **Personally I prefer this (B) option since it's more Railish.**
 
+### Access Current Site and Domain in Controllers
+After installing `site_framework` you'll have `site`, `domain` and `domain_name` methods
+on your `request` objects to access the respected models. But if current request belongs
+to default site the return value of these methods would be `nil`
+
+### Access Current Site/Domain elsewhre
+You can access to current `site`, `domain` and `domain_name` via `SiteFramework::CurrentState` object
+every where just like this:
+
+```ruby
+SiteFramework::CurrentState.instance.site
+SiteFramework::CurrentState.instance.domain
+SiteFramework::CurrentState.instance.domain_name
+```
+
+In case of default site these methods will return `nil`
+
 ### Model Concern
 **SiteFramework** provides an **ActiveSupport** concern which transparently
 makes your models aware of the current **Site** and **Domain**. By includeing
@@ -93,6 +110,13 @@ All you have to do is to open there models and include the given concern.
 
 Piece of cake. right?
 
+### Default template
+Since `v4.0` site model contains a field aka `default_template` which is blank by default.
+By default if current request does not belongs to default site and `default_template` is not
+blank, **site framework** will prepend the `default_template` to `view_path` of your application.
+
+By this feature each site can have their own set of views.
+
 ## Contributing
 
 1. Fork it

data/db/migrate/20160216141442_add_default_template_to_sites.rb

@@ -0,0 +1,9 @@
+class AddDefaultTemplateToSites < ActiveRecord::Migration[5.0]
+  def up
+    add_column :site_framework_sites, :default_template, :string, default: ''
+  end
+
+  def down
+    remove_column :site_framework_sites, :default_template
+  end
+end

data/lib/site_framework/action_controller/base.rb

@@ -0,0 +1,18 @@
+ActionController::Base.class_eval do
+
+  private
+
+  def set_template_path
+    unless request.site
+      # We are in site namespace
+      unless request.site.default_template.blank?
+        prepend_view_path[request.site.default_template]
+      end
+    end
+  end
+end
+
+
+ActionController::Base.instance_eval do
+  before_action :set_template_path
+end

data/lib/site_framework/routing/default_constraint.rb

@@ -19,6 +19,18 @@ class SiteFramework::Routing::DefaultConstraint
       SiteFramework::CurrentState.instance.domain      = nil
       SiteFramework::CurrentState.instance.site        = nil
 
+      request.instance_eval do
+        def site
+        end
+
+        def domain
+        end
+
+        def domamin_name
+        end
+
+      end
+
       true
     else
       logger.info("Domain name '#{request.host}' does not match with any exist domains")

data/lib/site_framework/routing/site_constraint.rb

@@ -25,6 +25,20 @@ class SiteFramework::Routing::SiteConstraint
       setup(domain_obj)
       initialize_site_default_state
 
+      request.instance_eval do
+        def site
+          domain_obj.site
+        end
+
+        def domain
+          domain_obj.domain
+        end
+
+        def domamin_name
+          domain_obj.domain_name
+        end
+      end
+
       true
     else
       logger.info("Domain name '#{request.host}' does not match with any exist domains")

data/lib/site_framework/routing/sites.rb

@@ -6,7 +6,7 @@ module SiteFramework::Routing
       end
     end
 
-    def default_site(mapper, defaults)
+    def default_site(mapper, defaults = nil)
       constraint = SiteFramework::Routing::DefaultConstraint.new(mapper,
                                                                  defaults)
       constraints(constraint) do

data/lib/site_framework/version.rb

@@ -1,3 +1,3 @@
 module SiteFramework
-  VERSION = '3.2.0'
+  VERSION = '4.0.0'
 end

data/lib/site_framework.rb

@@ -1,4 +1,3 @@
-require 'site_framework/current_state'
 require 'site_framework/helpers'
 
 # Main module of `site_framework` gem
@@ -10,11 +9,14 @@ module SiteFramework
   end
 end
 
+require 'site_framework/current_state'
 require 'site_framework/engine'
 require 'site_framework/railtie'
 require 'site_framework/orm'
 require 'site_framework/routing'
 require 'site_framework/action_dispatch'
+require 'site_framework/action_controller/base'
+
 
 case SiteFramework::ORM.current_orm
 when 'active_record'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: site_framework
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Sameer Rahmani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-14 00:00:00.000000000 Z
+date: 2016-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -69,7 +69,9 @@ files:
 - config/routes.rb
 - db/migrate/20140118200201_create_site_framework_domains.rb
 - db/migrate/20140303141448_create_site_framework_sites.rb
+- db/migrate/20160216141442_add_default_template_to_sites.rb
 - lib/site_framework.rb
+- lib/site_framework/action_controller/base.rb
 - lib/site_framework/action_dispatch.rb
 - lib/site_framework/active_record/concerns.rb
 - lib/site_framework/active_record/migration.rb