dynamic_styles 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf88a1d69f770729207432861e58206560fd50eb
+  data.tar.gz: 665e5a90e1190b73ef1aaa5b1676ba14e03efc12
+SHA512:
+  metadata.gz: c7d0da25b2896086a11b5ad4b39cb2c0d95a6511cf98d5e07e1c3f2775b331ab2d2b98958d0c8495f173b21fc61224eb98a5994700cfce8369ce0ccbebb69d0e
+  data.tar.gz: 370792e8a85d17f3546be84874e9689c84055906ac7e4fa4bebdfd99b6361b7ecadb3570b0ca73fc8e2b7f588fcb5f1b70945f9405de711bbba322c322496e4b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dynamic_styles.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Igor Davydov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# DynamicStyles
+
+This little gem add ability for your AR model to have a custom stylesheet, which plays nicely with asset pipeline.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dynamic_styles'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dynamic_styles
+
+## Usage
+
+Let's say you have a multi-tennant app, and tennants have the ability to modify their styles, which are attributes of Layout AR model.
+
+Just add mount_stylesheet to your Layout model and you'll be able to use layout.scss.erb (the template name is the same as your model) which is gets rendered to assets/stylesheets/layout/filename.css. Filename is created with Layout model timestamp, so this template will be re-rendered when Layout instance gets updated.
+
+In the template you will have 'layout' variable you can use to get the attributes needed. You will need to have some method like current_layout with the instance of you Layout model. To insert link to custom stylesheet in the application.html.erb file just use
+
+```
+<link href="<%= @current_layout.dynamic_stylesheet.path %>" media="screen" rel="stylesheet">
+```
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/dynamic_styles.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dynamic_styles/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dynamic_styles"
+  spec.version       = DynamicStyles::VERSION
+  spec.authors       = ["Igor Davydov"]
+  spec.email         = ["iskiche@gmail.com"]
+  spec.description   = "Use dynamic stylesheets compatible with asset pipeline"
+  spec.summary       = "Dynamic stylesheets for rails apps"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13"
+end

data/lib/dynamic_styles.rb

@@ -0,0 +1,4 @@
+require "dynamic_styles/version"
+require 'dynamic_styles/stylesheet'
+require 'dynamic_styles/asset_compiler'
+require 'dynamic_styles/mount'

data/lib/dynamic_styles/asset_compiler.rb

@@ -0,0 +1,39 @@
+module DynamicStyles
+  class AssetCompiler
+    def initialize(asset_path, scss_path=nil)
+      @asset_path = asset_path
+      @scss_path = Rails.root.join('app', 'assets', 'stylesheets', scss_path)
+      @env = Rails.application.assets.instance_variable_get('@environment') if precompilation?
+    end
+
+    def precompilation?
+      !Rails.application.config.assets.compile
+    end
+
+    def compiled?
+      if precompilation?
+        @env.find_asset(@asset_path).present?
+      else
+        File.exists?(@scss_path) && !File.zero?(@scss_path)
+      end
+    end
+
+    def digest
+      @env.find_asset(@asset_path).digest
+    end
+
+    def manifest_path
+      File.join(Rails.public_path, Rails.application.config.assets.prefix)
+    end
+
+    def compile!
+      if precompilation?
+        Sprockets::Manifest.new(@env, self.manifest_path).compile(@asset_path)
+      end
+    end
+
+    def write_template!(string)
+      File.open(@scss_path, 'w') { |f| f.write(string) }
+    end
+  end
+end

data/lib/dynamic_styles/mount.rb

@@ -0,0 +1,22 @@
+module DynamicStyles
+  module Mount
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def mount_stylesheet(options = {})
+        include DynamicStyles::Mount::LocalInstanceMethods
+      end
+    end
+
+    module LocalInstanceMethods
+      def dynamic_stylesheet
+        DynamicStyles::Stylesheet.new(self)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, DynamicStyles::Mount

data/lib/dynamic_styles/stylesheet.rb

@@ -0,0 +1,75 @@
+require 'active_support/core_ext'
+
+module DynamicStyles
+  class Stylesheet
+
+    delegate :precompilation?, :digest, :compiled?, :compile!, :write_template!, :to => :compiler
+
+    def initialize(layout)
+      @layout = layout
+    end
+
+    def compiler
+      AssetCompiler.new(asset_path, scss_path)
+    end
+
+    def public_path
+      precompilation? ? digested_path : undigested_path
+    end
+
+    def base_path
+      "#{template_name.pluralize}/#{base_filename}"
+    end
+
+    def asset_path
+      "#{base_path}.css"
+    end
+
+    def scss_path
+      "#{base_path}.scss"
+    end
+
+    def undigested_path
+      "/assets/#{base_path}.css"
+    end
+
+    def digested_path
+      "/assets/#{base_path}-#{digest}.css"
+    end
+
+    def template_name
+      @layout.class.to_s.downcase.split('::').last
+    end
+
+    def base_filename
+      [
+        @layout.id,
+        @layout.updated_at.to_s(:number),
+        template_name
+      ].join('-')
+    end
+
+    def path
+      compile
+      public_path
+    end
+
+    def compile
+      unless compiled?
+        write_template!(render_template)
+        compile!
+        # cleanup
+      end
+    end
+
+    def render_template
+      class_name = @layout.class.to_s
+      controller = (class_name.pluralize + "Controller").constantize
+      controller.new.render_to_string template_name,
+        formats: [:scss],
+        layout:  false,
+        locals:  { :"#{class_name.downcase}" => @layout }
+    end
+
+  end
+end

data/lib/dynamic_styles/version.rb

@@ -0,0 +1,3 @@
+module DynamicStyles
+  VERSION = "0.0.1"
+end

data/spec/stylesheet_spec.rb

@@ -0,0 +1,76 @@
+require 'dynamic_styles/asset_compiler'
+require 'dynamic_styles/stylesheet'
+
+module DynamicStyles
+  describe Stylesheet do
+    let(:site) { double 'Site' }
+    let(:stylesheet) { Stylesheet.new(site) }
+    let(:compiler) { double 'AssetCompiler'}
+
+    before(:each) do
+      stylesheet.stub(:base_filename) {'base_name'}
+      stylesheet.stub(:template_name) {'site'}
+      AssetCompiler.stub(:new) { @compiler }
+    end
+
+    it "#base_filename is timestamped with parent model" do
+      stylesheet.unstub(:base_filename)
+      site.stub(:id) {'-1'}
+      site.stub(:updated_at) { Time.new 12345 }
+      stylesheet.base_filename.should == "#{site.id}-123450101000000-site"
+    end
+
+    it "#asset_path returns relative path from assets dir" do
+      stylesheet.asset_path.should == "sites/#{stylesheet.base_filename}.css"
+    end
+
+    context "assets not precompiled" do
+      before :each do
+       stylesheet.stub(:precompilation?) { false }
+      end
+
+      it "#public_path returns usual asset path in development" do
+        stylesheet.public_path.should == "/assets/sites/#{stylesheet.base_filename}.css"
+      end
+    end
+
+    context "assets are precompiled" do
+      before :each do
+        stylesheet.stub(:precompilation?) { true }
+      end
+
+      it "#public_filename is digested" do
+        compiler = double 'AssetCompiler'
+        AssetCompiler.stub(:new) { compiler }
+        compiler.stub(:digest) { 987654321 }
+        stylesheet.public_path.should == "/assets/sites/#{stylesheet.base_filename}-987654321.css"
+      end
+      it "asset is recompiled if parent changed" do
+        stylesheet.stub(:render_template) { 'asdf'}
+        stylesheet.stub(:compiled?) { false }
+        stylesheet.should_receive(:write_template!)
+        stylesheet.should_receive(:compile!)
+        stylesheet.compile
+      end
+    end
+
+    describe "compilation:" do
+      before(:each) do
+        @compiler = double 'AssetCompiler'
+        AssetCompiler.stub(:new) { @compiler }
+      end
+
+      it "#compile! compiles with manifest" do
+        @compiler.should_receive(:compile!)
+        stylesheet.compile!
+      end
+
+      it "#render_template renders and saves to file" do
+        @compiler.should_receive(:write_template!)
+        stylesheet.write_template!
+      end
+
+    end
+
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: dynamic_styles
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Igor Davydov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: Use dynamic stylesheets compatible with asset pipeline
+email:
+- iskiche@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dynamic_styles.gemspec
+- lib/dynamic_styles.rb
+- lib/dynamic_styles/asset_compiler.rb
+- lib/dynamic_styles/mount.rb
+- lib/dynamic_styles/stylesheet.rb
+- lib/dynamic_styles/version.rb
+- spec/stylesheet_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Dynamic stylesheets for rails apps
+test_files:
+- spec/stylesheet_spec.rb