site_framework 2.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94b6186c75da0ee9ffc116cd0dd921b11f489124
-  data.tar.gz: c33db9d98b3797824f147aaee44e52e0455d7bb2
+  metadata.gz: cc343768092e51720768dc4b7a0d898bd9f70d56
+  data.tar.gz: 01aa8c586ca705123082dd960fa6532dc6eb467c
 SHA512:
-  metadata.gz: 53407175606216896d048ae7e205c77849bf854296e52e72653dccd3eaf3a22953988dd1f935f7cb5309ad6dd7825105cf73117ca38bb1e430a3748a1c37d865
-  data.tar.gz: b77ad68f0ddcd15fe4542a4fb9ff60345faaa9ab88528711f6d534d2b9f82f25130fa0d7171bcdfa3e3faf04212981c42d1872ef66cc0c3ed8700614e2f72afe
+  metadata.gz: ae5fa48b1d33a01beffe3566a4ba77383ffaea071f09da5b0508fc37f17a499022b6960098c8aa0e76913086532a6744f23d9a6f616d1322a0139741bf8217b0
+  data.tar.gz: 806d3320c628af9a50e672138ca0a378c9eda43db5858156b81edba151d3c969a5b886477a8bfab1229287ce594601156f5f17c0b314bae18c5e9d46670fe415

data/README.md

@@ -1,4 +1,6 @@
-# SiteFramework - [![Gem Version](https://badge.fury.io/rb/site_framework.png)](http://badge.fury.io/rb/site_framework)
+# SiteFramework
+[![Gem Version](https://badge.fury.io/rb/site_framework.png)](http://badge.fury.io/rb/site_framework)
+[![Downloads](https://img.shields.io/gem/dt/site_framework.svg)](http://rubygems/gems/site_framework)
 
 A site framework for Ruby on Rails web framework inspired by Django site fremework.
 The idea of this gem to transparently make Rails apps to work with different domains.
@@ -54,12 +56,27 @@ Just use `sites` DSL in your `routes.rb`. e.g:
 ```ruby
 Rails.application.routes.draw do
 
+  # Share routes
   get 'home/index'
 
   # All the routes defined in this section will be domain aware.
-  sites do
+  sites(self) do
     root 'home#index'
   end
+
+  default_site(self) do
+    # routs for default site
+  end
+end
+```
+Note: You can provide default domains for **SiteFramework** via an
+initializer like this:
+
+```ruby
+SiteFramework.setup do |config|
+
+  config.default_domains = ['localhost', 'example.com']
+
 end
 ```
 

data/app/models/site_framework/domain.rb

@@ -27,7 +27,7 @@ module SiteFramework
       belongs_to :site
 
       # Self relation
-      belongs_to :parent, class_name: self.class
+      belongs_to :parent, class_name: self.class.to_s
       validates_associated :site
     end
 

data/lib/site_framework/current_state.rb

@@ -0,0 +1,7 @@
+# This singleton class act as an temp storage for the
+# current site and domain
+class SiteFramework::CurrentState
+  include Singleton
+
+  attr_accessor :site, :domain, :domain_name
+end

data/lib/site_framework/engine.rb

@@ -9,5 +9,12 @@ module SiteFramework
       g.test_framework :rspec
     end
 
+    @@default_domains = ['localhost']
+
+    mattr_accessor :default_domains
+
+    def self.setup
+      yield self
+    end
   end
 end

data/lib/site_framework/helpers.rb

@@ -0,0 +1,35 @@
+require 'site_framework/current_state'
+
+module SiteFramework
+
+  # Return the current site, domain, domain_name
+  # if it wasn't the default site
+  module DummyHelper
+
+    def current_site
+      SiteFramework::CurrentState.instance.site
+    end
+
+    def current_domain
+      SiteFramework::CurrentState.instance.domain
+    end
+
+    def current_domain_name
+      SiteFramework::CurrentState.instance.domain_name
+    end
+
+    def default_site?
+      return true if SiteFramework::CurrentState.instance.site.nil?
+      false
+    end
+  end
+
+  module Helpers
+    extend ActiveSupport::Concern
+    include SiteFramework::DummyHelper
+
+    module ClassMethods
+      include SiteFramework::DummyHelper
+    end
+  end
+end

data/lib/site_framework/routing/default_constraint.rb

@@ -0,0 +1,29 @@
+class SiteFramework::Routing::DefaultConstraint
+
+  attr_reader :logger
+
+  def initialize(mapper, defaults = nil)
+    @logger          = Rails.logger
+    @mapper          = mapper
+    @default_domains = defaults || SiteFramework::Engine.default_domains
+  end
+
+
+  def matches?(request)
+    @domain_name = request.host
+
+    if @default_domains.include? @domain_name
+      logger.debug("Loading default site configuration")
+
+      SiteFramework::CurrentState.instance.domain_name = nil
+      SiteFramework::CurrentState.instance.domain      = nil
+      SiteFramework::CurrentState.instance.site        = nil
+
+      true
+    else
+      logger.info("Domain name '#{request.host}' does not match with any exist domains")
+      false
+    end
+  end
+
+end

data/lib/site_framework/routing/site_constraint.rb

@@ -2,80 +2,46 @@ class SiteFramework::Routing::SiteConstraint
 
   attr_reader :logger
 
-  def initialize
+  def initialize(mapper)
     @logger = Rails.logger
+    @mapper = mapper
   end
 
-  def domains
-    SiteFramework::Domain.select('DISTINCT name').map(&:name).uniq
+  def domain(name)
+    @domain ||= if defined? ActiveRecord
+      SiteFramework::Domain.find_by(name: name)
+    elsif defined? Mongoid
+      SiteFramework::Site.where('domains.name' => name).domains.first
+    else
+      nil
+    end
   end
 
   def matches?(request)
-    if domains.include? request.host
-      define_domain_name         request.host
-      define_fetch_domain_method request.host
-      define_domain
-      define_site
+    @domain_name = request.host
+
+    if domain_obj = domain(request.host)
+      logger.debug("''#{@domain_name}' matched.")
+      setup(domain_obj)
+      initialize_site_default_state
+
       true
     else
-
       logger.info("Domain name '#{request.host}' does not match with any exist domains")
       false
     end
-
   end
 
   private
 
-  def define_domain_name(domain)
-    Rails.application.send :define_singleton_method, 'domain_name' do
-      domain
-    end
+  def setup(domain)
+    SiteFramework::CurrentState.instance.domain_name = domain.name
+    SiteFramework::CurrentState.instance.domain      = domain
+    SiteFramework::CurrentState.instance.site        = domain.site
+    @site                                            = domain.site
   end
 
-  def define_domain
-    # TODO: Find a better way to do this.
-    Rails.application.send :define_singleton_method, 'domain' do
-      domain_ = nil
-      if Rails.application.instance_variable_defined? '@domain'
-        domain_ = Rails.application.instance_variable_get '@domain'
-        if respond_to? :logger
-          logger.info "`domain` is defined, value #{domain}"
-        end
-      end
-
-      if domain_.nil?
-        # Fetch domain by calling **fetch_domain** method on
-        # **Rails.application**
-        domain_obj = fetch_domain
-        if respond_to? :logger
-          logger.debug '`domain` is nil'
-          logger.warn "Can't find domain object of `#{Rails.application.domain_name}`"
-        end
-        Rails.application.instance_variable_set '@domain', domain_obj
-        domain_ = domain_obj
-      end
-
-      domain_
-    end
-
-  end
-
-  def define_site
-    Rails.application.send :define_singleton_method, 'site' do
-      site = nil
-      site = Rails.application.domain.site unless Rails.application.domain.nil?
-      site
-    end
-  end
-
-  def define_fetch_domain_method(domain)
-    Rails.application.send :define_singleton_method, 'fetch_domain' do
-      if defined? ActiveRecord
-        Domain.find_by(nam: domain)
-      elsif defined? Mongoid
-        Site.where('domains.name' => domain).domains.first
-      end
-    end
+  def initialize_site_default_state
+    @site.try(:before_dispatch, @mapper)
   end
 end

data/lib/site_framework/routing/sites.rb

@@ -1,8 +1,16 @@
 module SiteFramework::Routing
   module Sites
-    def sites(&block)
-      constraints(SiteFramework::Routing::SiteConstraint.new) do
-        block.call
+    def sites(mapper)
+      constraints(SiteFramework::Routing::SiteConstraint.new(mapper)) do
+        yield
+      end
+    end
+
+    def default_site(mapper, defaults)
+      constraint = SiteFramework::Routing::DefaultConstraint.new(mapper,
+                                                                 defaults)
+      constraints(constraint) do
+        yield
       end
     end
   end

data/lib/site_framework/routing.rb

@@ -0,0 +1,3 @@
+require 'site_framework/routing/site_constraint'
+require 'site_framework/routing/default_constraint'
+require 'site_framework/routing/sites'

data/lib/site_framework/version.rb

@@ -1,3 +1,3 @@
 module SiteFramework
-  VERSION = "2.0.0"
+  VERSION = '3.1.0'
 end

data/lib/site_framework.rb

@@ -1,6 +1,10 @@
+require 'site_framework/current_state'
+require 'site_framework/helpers'
+
 # Main module of `site_framework` gem
 module SiteFramework
   autoload :Middleware, 'site_framework/middleware'
+  include  SiteFramework::Helpers
 
   module Routing
   end
@@ -9,8 +13,7 @@ end
 require 'site_framework/engine'
 require 'site_framework/railtie'
 require 'site_framework/orm'
-require 'site_framework/routing/site_constraint'
-require 'site_framework/routing/sites'
+require 'site_framework/routing'
 require 'site_framework/action_dispatch'
 
 case SiteFramework::ORM.current_orm

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: site_framework
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Sameer Rahmani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -73,11 +73,15 @@ files:
 - lib/site_framework/action_dispatch.rb
 - lib/site_framework/active_record/concerns.rb
 - lib/site_framework/active_record/migration.rb
+- lib/site_framework/current_state.rb
 - lib/site_framework/engine.rb
+- lib/site_framework/helpers.rb
 - lib/site_framework/middleware.rb
 - lib/site_framework/mongoid/concerns.rb
 - lib/site_framework/orm.rb
 - lib/site_framework/railtie.rb
+- lib/site_framework/routing.rb
+- lib/site_framework/routing/default_constraint.rb
 - lib/site_framework/routing/site_constraint.rb
 - lib/site_framework/routing/sites.rb
 - lib/site_framework/version.rb