site_framework 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc7c3abea6d256318fb880272c6865135880642f
-  data.tar.gz: fb016cffae231550d57e5343ea9b0658ede0ca5f
+  metadata.gz: 94b6186c75da0ee9ffc116cd0dd921b11f489124
+  data.tar.gz: c33db9d98b3797824f147aaee44e52e0455d7bb2
 SHA512:
-  metadata.gz: b4dcfa4473e9ed0a939880e9429b83dd9cd3d7a45ed1777dae38e0ab258ac7625cedde86d2881a29f5725e629ddff1da7a6e292d303a004702d0e9da862dbbc0
-  data.tar.gz: 3d687c3440dc7422b201ca1f146401117cfe1ac53d4bee83e718a6b3b9754a713e84ed939ee8b38c796370db9c3236419e3e51e548d1c119889d4920b1fd5527
+  metadata.gz: 53407175606216896d048ae7e205c77849bf854296e52e72653dccd3eaf3a22953988dd1f935f7cb5309ad6dd7825105cf73117ca38bb1e430a3748a1c37d865
+  data.tar.gz: b77ad68f0ddcd15fe4542a4fb9ff60345faaa9ab88528711f6d534d2b9f82f25130fa0d7171bcdfa3e3faf04212981c42d1872ef66cc0c3ed8700614e2f72afe

data/README.md

@@ -1,3 +1,96 @@
 # SiteFramework - [![Gem Version](https://badge.fury.io/rb/site_framework.png)](http://badge.fury.io/rb/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 facilities to work with different domains.
+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.
+
+**Warning**: This gem is still on development. I'll be happy to have your feedback.
+
+## Installation
+
+Add `site_framework` to your `Gemfile`:
+
+```ruby
+gem 'site_framework'
+```
+
+and after installing your project dependencies using `bundle install` command. Install
+**SiteFramework** migrations like:
+
+```bash
+rake site_framework:install:migrations
+```
+
+That's it.
+
+## Usage
+
+**SiteFramework** provides to solution to multi-site support.
+
+In both solution you have to add a migration for your tables and
+make them domain aware (ActiveRecord Only). e.g in your migration:
+
+```ruby
+# Make posts table domain aware
+domain_aware(:posts)
+```
+
+If you're using **Mongoid** just add a reference to **SiteFramework::Domain** in your model.
+
+When a request arrives to the Rails application `SiteFramework` will add three different
+methods to `Rails.application`.
+
+* **domain**: An instance of `SiteFramework::Domain` model which refer to current domain of
+the request
+* **domain_name**: Current domain as string.
+* **Site**: An instance of `SiteFramework::Site` model which refer to current site.
+
+
+### A) Rack middleware:
+Simply add `SiteFramework::Middleware` to your middleware stack.
+
+### B) Constrants
+Just use `sites` DSL in your `routes.rb`. e.g:
+
+```ruby
+Rails.application.routes.draw do
+
+  get 'home/index'
+
+  # All the routes defined in this section will be domain aware.
+  sites do
+    root 'home#index'
+  end
+end
+```
+
+**Personally I prefer this (B) option since it's more Railish.**
+
+### Model Concern
+**SiteFramework** provides an **ActiveSupport** concern which transparently
+makes your models aware of the current **Site** and **Domain**. By includeing
+`SiteFramework::DomainAware` into your model, default scope of your model will
+change to return only records which belongs to current **Site**.
+
+This way you can use external gems with your multi-site application easily.
+All you have to do is to open there models and include the given concern.
+
+Piece of cake. right?
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credit
+![Yellowen](http://www.yellowen.com/images/logo.png)
+
+**SiteFramework**  is maintained and funded by Yellowen. Whenever a code snippet is borrowed or inspired by existing code,
+we try to credit the original developer/designer in our source code. Let us know if you think we have missed to do this.
+
+
+# License
+
+**SiteFramework** is Copyright © 2014-2015 Yellowen. It is free software, and may be redistributed under the terms specified in the LICENSE file.

data/app/models/site_framework/domain.rb

@@ -4,13 +4,15 @@ module SiteFramework
   # belongs to another  **Domain**
   class Domain < (defined?(ActiveRecord) ? ActiveRecord::Base : Object)
 
+    PATTERN = /\A[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?\z/ix
+
     if defined? Mongoid
       include Mongoid::Document
       include Mongoid::Timestamps
 
-      field :name, :type => String
-      field :parent, :type => String
-      field :alias, :type => Boolean
+      field :name,   type: String
+      field :parent, type: String,  default: nil
+      field :alias,  type: Boolean, default: false
 
       embedded_in :site
 
@@ -25,12 +27,17 @@ module SiteFramework
       belongs_to :site
 
       # Self relation
-      belongs_to :parent, :class_name => self.class
+      belongs_to :parent, class_name: self.class
       validates_associated :site
     end
 
-    validates :name, :presence => true,
-       :format => { :with => /\A(?:[a-z0-9\-]+\.)+[a-z]{2,4}\z/i }
+    validates(:name, presence: true, format: { with: PATTERN })
     validates_uniqueness_of :name
+
+    before_save :normalize_name
+
+    def normalize_name
+      self.name = name.downcase
+    end
   end
 end

data/db/migrate/20140118200201_create_site_framework_domains.rb

@@ -1,14 +1,14 @@
 class CreateSiteFrameworkDomains < ActiveRecord::Migration
   def change
     create_table :site_framework_domains do |t|
-       t.string :name
-       t.integer :site_id
-       t.integer :parent_id
-       t.boolean :alias
+      t.string :name
+      t.integer :site_id
+      t.integer :parent_id, default: nil
+      t.boolean :alias, default: false
 
-       t.timestamps
+      t.timestamps
     end
 
-    add_index :site_framework_domains, :name, :unique => true
+    add_index :site_framework_domains, :name, unique: true
   end
 end

data/lib/site_framework/action_dispatch.rb

@@ -0,0 +1,3 @@
+class ActionDispatch::Routing::Mapper
+  include SiteFramework::Routing::Sites
+end

data/lib/site_framework/active_record/concerns.rb

@@ -6,6 +6,5 @@ module SiteFramework
       belongs_to :domain
       default_scope -> { where(:domain => Rails.application.domain) }
     end
-
   end
 end

data/lib/site_framework/middleware.rb

@@ -29,30 +29,6 @@ module SiteFramework
         end
       end
 
-      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
-
       Rails.application.send :define_singleton_method, 'site' do
         site = nil
         unless Rails.application.domain.nil?

data/lib/site_framework/routing/site_constraint.rb

@@ -0,0 +1,81 @@
+class SiteFramework::Routing::SiteConstraint
+
+  attr_reader :logger
+
+  def initialize
+    @logger = Rails.logger
+  end
+
+  def domains
+    SiteFramework::Domain.select('DISTINCT name').map(&:name).uniq
+  end
+
+  def matches?(request)
+    if domains.include? request.host
+      define_domain_name         request.host
+      define_fetch_domain_method request.host
+      define_domain
+      define_site
+      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
+  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
+  end
+end

data/lib/site_framework/routing/sites.rb

@@ -0,0 +1,9 @@
+module SiteFramework::Routing
+  module Sites
+    def sites(&block)
+      constraints(SiteFramework::Routing::SiteConstraint.new) do
+        block.call
+      end
+    end
+  end
+end

data/lib/site_framework/version.rb

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

data/lib/site_framework.rb

@@ -1,10 +1,18 @@
 # Main module of `site_framework` gem
 module SiteFramework
+  autoload :Middleware, 'site_framework/middleware'
+
+  module Routing
+  end
 end
 
-require "site_framework/engine"
+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/action_dispatch'
+
 case SiteFramework::ORM.current_orm
 when 'active_record'
   require 'site_framework/active_record/migration'
@@ -12,5 +20,3 @@ when 'active_record'
 when 'mongoid'
   require 'site_framework/mongoid/concerns'
 end
-
-require 'site_framework/middleware'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: site_framework
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Sameer Rahmani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2015-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -70,6 +70,7 @@ files:
 - db/migrate/20140118200201_create_site_framework_domains.rb
 - db/migrate/20140303141448_create_site_framework_sites.rb
 - lib/site_framework.rb
+- lib/site_framework/action_dispatch.rb
 - lib/site_framework/active_record/concerns.rb
 - lib/site_framework/active_record/migration.rb
 - lib/site_framework/engine.rb
@@ -77,6 +78,8 @@ files:
 - lib/site_framework/mongoid/concerns.rb
 - lib/site_framework/orm.rb
 - lib/site_framework/railtie.rb
+- lib/site_framework/routing/site_constraint.rb
+- lib/site_framework/routing/sites.rb
 - lib/site_framework/version.rb
 - lib/tasks/site_framework_tasks.rake
 - spec/dummy/README.rdoc