rack-sassc 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2b6576825c66fc983efbdb31c7c9f140f6b6d75bfcdf7b5b4ca05f98ccccbe8
+  data.tar.gz: fc2728ba84d1ea93577ed8e40da1492d84541fb83d35edf9bf76769094aa2ec5
+SHA512:
+  metadata.gz: 44aa927dc2e90882201445447589ab5df67c538c212ca2777dd72f604e933bc0be7e539f1f33c57d1b06bc0153145a074ff07ea93094f8144e8dcf2c22c1f36f
+  data.tar.gz: 29ce04609231b501f4028a7c53c93af24793b843ea6692f489e6e4a07e7f844507a48c8245b1f4976f258e449858ad9fa7d2aa90008c5cce24e4834a9d0b9dbf

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_STORE
+*.swp
+.ruby-version
+pkg/
+Gemfile.lock
+*.gem
+.bundle/
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Mickael Riga
+
+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,131 @@
+Rack::SassC
+===========
+
+Rack middleware for processing sass/scss files. The current version has many 
+limitations but feel free to send pull requests if you find a bug or if you wish 
+to improve the functionnalities.
+
+The current behaviour implies these limitations:
+
+The files are processed each time they are requested. Since by default it does 
+it only when not in production, the speed penalty is kind of acceptable. But I 
+intend to improve it and use modification time.
+
+The location of the public directory and directory names for CSS and SCSS are 
+editable, but both are assumed to be directly placed inside the public 
+directory.
+
+The files cannot be nested, they are assumed to be directly inside the SCSS 
+directory, and the generated files are therefore created directly inside the CSS 
+directory.
+
+There is no special error handling yet. Any error will raise a typical error 
+page.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-sassc'
+```
+
+And then execute:
+
+```ruby
+bundle install
+```
+
+Or install it yourself as:
+
+```ruby
+gem install rack-sassc
+```
+
+Usage
+-----
+
+In your `config.ru`:
+
+```ruby
+require 'rack/sassc'
+
+use Rack::SassC
+```
+
+This is the basic usage with default behaviour, which is equivalent to using 
+these options:
+
+```ruby
+require 'rack/sassc'
+
+use Rack::SassC, {
+  check: ENV['RACK_ENV'] != 'production',
+  public_location: 'public',
+  syntax: :scss,
+  css_dirname: :css,
+  scss_dirname: :scss,
+  create_map_file: true,
+}
+```
+
+Here is the explanation for each option:
+
+`check` determines if the files are processed or not. Setting it to `false` is 
+equivalent to not having the middleware at all. By default it is `true` if the 
+rack environment is NOT `production`. The value of `check` can also be a Proc 
+which receives the `env` on each request.
+
+`public_location` is where you serve static files on your app. It is set to 
+"public" by default. Whatever path you set it to will be expanded.
+
+`scss_dirname` and `css_dirname` are just the name of the directories in which 
+we search for template files and we generate css/map files.
+
+`syntax` is `:scss` or `:sass`. It is used for the engine, but also for the 
+extension of template files, which means they have to match.
+
+`create_map_file` is self explanatory. No map file will be created if set to 
+`false`.
+
+Additionally, you can pass another option called `engine_opts`. It will be 
+merged with the default options of the SassC engine. For example if you don't 
+want a compressed output, you could do this:
+
+```ruby
+use Rack::SassC, {
+  engine_opts: {style: :nested}
+}
+```
+
+The default options for the engine are the following:
+
+```ruby
+{
+  style: :compressed, 
+  syntax: @opts[:syntax],
+  load_paths: [location(@opts[:scss_dirname])],
+}
+```
+
+Or this when no map file is to be created:
+
+```ruby
+{
+  style: :compressed, 
+  syntax: @opts[:syntax],
+  load_paths: [location(@opts[:scss_dirname])],
+  source_map_file: "#{filename}.css.map",
+  source_map_contents: true,
+}
+```
+
+Alternatives
+------------
+
+As far as I know the only alternative to this library is 
+[SasscRack](https://github.com/hkrutzer/sasscrack) by 
+[hkrutzer](https://github.com/hkrutzer) which arguably has a much better name 
+than mine `;-)`
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.warning = false
+  t.options = '--pride'
+end
+
+desc "Run tests"
+task :default => :test
+

data/lib/rack/sassc/version.rb

@@ -0,0 +1,6 @@
+module Rack
+  class SassC
+    VERSION = '0.0.0'
+  end
+end
+

data/lib/rack/sassc.rb

@@ -0,0 +1,93 @@
+require 'sassc'
+
+module Rack
+  class SassC
+
+    attr_reader :opts
+
+    def initialize app, opts={}
+      @app = app
+
+      @opts = {
+        check: ENV['RACK_ENV'] != 'production',
+        public_location: 'public',
+        syntax: :scss,
+        css_dirname: :css,
+        scss_dirname: :scss,
+        create_map_file: true,
+      }.merge(opts)
+
+      @opts[:public_location] = ::File.expand_path @opts[:public_location]
+    end
+
+    def call env
+      handle_path(env['PATH_INFO']) if must_check?(env)
+      @app.call env
+    end
+
+    def location dirname
+      ::File.join @opts[:public_location], dirname.to_s
+    end
+
+    def filepath dirname, filename, ext
+      ::File.join location(dirname), "#{filename}.#{ext}"
+    end
+
+    private
+
+    def must_check? env
+      if @opts[:check].respond_to? :call
+        @opts[:check].call env
+      else
+        @opts[:check]
+      end
+    end
+
+    def handle_path path_info
+      return unless path_info[/\/#{@opts[:css_dirname]}\/[^\/]+\.css$/]
+
+      filename = ::File.basename path_info, '.*'
+      scss_filepath = filepath(@opts[:scss_dirname], filename, @opts[:syntax])
+      return unless ::File.exist?(scss_filepath)
+
+      scss = ::File.read(scss_filepath)
+      engine = ::SassC::Engine.new(scss, build_engine_opts(filename))
+      css_filepath = filepath(@opts[:css_dirname], filename, :css)
+
+      ::File.open(css_filepath, 'w') do |css_file|
+        css_file.write(engine.render)
+      end
+
+      if @opts[:create_map_file]
+        ::File.open("#{css_filepath}.map", 'w') do |map_file|
+          map_file.write(engine.source_map)
+        end
+      end
+    end
+
+    def build_engine_opts filename
+      engine_opts = {
+        style: :compressed, 
+        syntax: @opts[:syntax],
+        load_paths: [location(@opts[:scss_dirname])],
+      }
+
+      if @opts[:create_map_file]
+        engine_opts.merge!({
+          source_map_file: "#{filename}.css.map",
+          source_map_contents: true,
+        })
+      end
+
+      if @opts.has_key?(:engine_opts)
+        engine_opts.merge! @opts[:engine_opts]
+      end
+
+      engine_opts
+    end
+
+  end
+end
+
+require 'rack/sassc/version'
+

data/lib/rack-sassc.rb

@@ -0,0 +1,2 @@
+require 'rack/sassc'
+

data/rack-sassc.gemspec

@@ -0,0 +1,22 @@
+require File.join(File.dirname(__FILE__), 'lib/rack/sassc/version')
+
+Gem::Specification.new do |s|
+  s.name          = 'rack-sassc'
+  s.version       = Rack::SassC::VERSION
+  s.summary       = "Rack middleware for SassC"
+  s.description   = "Rack middleware for SassC which process sass/scss files when in development environment."
+  s.authors       = ["Mickael Riga"]
+  s.email         = ["mig@mypeplum.com"]
+  s.files         = `git ls-files -z`.split("\x0")
+  s.homepage      = "https://github.com/mig-hub/rack-sassc"
+  s.license       = 'MIT'
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'rack', '>= 1.0'
+  s.add_dependency 'sassc', '~> 2.0'
+  s.add_development_dependency 'minitest', '~> 5.8'
+  s.add_development_dependency 'rack-test', '~> 0.6'
+  s.add_development_dependency "rake"
+  s.add_development_dependency "bundler"
+end
+

data/test/other-public/sassc/main.sass

@@ -0,0 +1,3 @@
+body
+  color: blue
+

data/test/other-public/stylesheets/main.css

@@ -0,0 +1,3 @@
+body{color:blue}
+
+/*# sourceMappingURL=main.css.map */

data/test/other-public/stylesheets/main.css.map

@@ -0,0 +1,12 @@
+{
+	"version": 3,
+	"file": "stdin.css",
+	"sources": [
+		"stdin"
+	],
+	"sourcesContent": [
+		"body {\n  color: blue; }\n\n"
+	],
+	"names": [],
+	"mappings": "AAAA,AAAA,IAAI,AAAC,CACH,KAAK,CAAE,IAAI,CAAG"
+}

data/test/public/css/already.css

@@ -0,0 +1 @@
+.already{color:yellow}

data/test/public/scss/main.scss

@@ -0,0 +1,3 @@
+body {
+  color: yellow;
+}

data/test/test_rack_sassc.rb

@@ -0,0 +1,198 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'rack/sassc'
+require 'rack/test'
+require 'minitest/autorun'
+
+# Simulate a setup where `public` is in the current directory
+Dir.chdir('test')
+
+class TestRackSassC < MiniTest::Test
+
+  include Rack::Test::Methods
+
+  KEEP_IN_CSS_DIR = ['already.css']
+
+  def setup
+    teardown
+    @inner_app = inner_app
+    @app_options = {}
+  end
+
+  def teardown
+    Dir.children('public/css').each do |f|
+      ::File.delete("public/css/#{f}") unless KEEP_IN_CSS_DIR.include?(f)
+    end
+    if ::File.exist? "public/scss/tmp.scss"
+      ::File.delete "public/scss/tmp.scss"
+    end
+  end
+
+  def app
+    Rack::Lint.new(Rack::SassC.new(@inner_app, @app_options))
+  end
+
+  def inner_app
+    Rack::Static.new(lambda {|env|
+      [200, {'Content-Type'=>'text/plain'}, ["Inner"]]
+    }, {
+      urls: ["/css", "/scss"], 
+      root: "public"
+    })
+  end
+
+  def inner_app_other
+    Rack::Static.new(lambda {|env|
+      [200, {'Content-Type'=>'text/plain'}, ["Inner"]]
+    }, {
+      urls: ["/stylesheets", "/sassc"], 
+      root: "other-public"
+    })
+  end
+
+  def test_non_css_request_is_served
+    get "/"
+    assert_equal 200, last_response.status
+    assert_equal "Inner", last_response.body
+    assert_css_dir_untouched
+  end
+
+  def test_existing_file_without_sassc_template_is_served
+    # Files that are already css from a library or something.
+    get "/css/already.css"
+    assert_equal 200, last_response.status
+    assert_equal 'text/css', last_response.headers['Content-Type']
+    assert last_response.body[/\.already\{color:yellow\}/]
+    assert_css_dir_untouched
+  end
+
+  def test_non_existing_file_without_sassc_template_is_not_found
+    # There is neither a file in css or in scss
+    get "/css/notfound.css"
+    assert_equal 404, last_response.status
+    assert_css_dir_untouched
+  end
+
+  def test_file_with_sassc_template_but_wrong_css_path_pass_through
+    # There is corresponding file in scss but the css path is wrong
+    get "/wrong-css/main.css"
+    assert_equal 200, last_response.status
+    assert_equal "Inner", last_response.body
+    assert_css_dir_untouched
+  end
+
+  def test_file_with_sassc_template_is_created_and_served
+    get "/css/main.css"
+    assert_equal 200, last_response.status
+    assert_equal 'text/css', last_response.headers['Content-Type']
+    assert last_response.body[/body\{color:yellow\}/]
+    assert last_response.body[/sourceMappingURL=main\.css\.map/]
+    assert_created_in_css_dir "main.css", "main.css.map"
+  end
+
+  def test_file_with_sassc_template_is_uptodate
+    ::File.open('public/scss/tmp.scss', 'w') do |file|
+      file.write "body{color:yellow}"
+    end
+    get "/css/tmp.css"
+    ::File.open('public/scss/tmp.scss', 'w') do |file|
+      file.write "body{color:orange}"
+    end
+    get "/css/tmp.css"
+    assert_equal 200, last_response.status
+    assert_equal 'text/css', last_response.headers['Content-Type']
+    assert last_response.body[/body\{color:orange\}/]
+    refute last_response.body[/yellow/]
+    assert last_response.body[/sourceMappingURL=tmp\.css\.map/]
+    assert_created_in_css_dir "tmp.css", "tmp.css.map"
+  end
+
+  def test_option_to_not_create_map_file
+    @app_options = {create_map_file: false}
+    get "/css/main.css"
+    assert_equal 200, last_response.status
+    assert_equal 'text/css', last_response.headers['Content-Type']
+    assert last_response.body[/body\{color:yellow\}/]
+    refute last_response.body[/sourceMappingURL/]
+    assert_created_in_css_dir "main.css"
+  end
+
+  def test_middleware_can_be_disabled_via_check_option
+    @app_options = {check: false}
+    get "/css/main.css"
+    assert_equal 404, last_response.status
+    assert_css_dir_untouched
+  end
+
+  def test_check_option_can_be_a_proc
+    @app_options = {
+      check: proc{ |env|
+        assert_equal '/css/main.css', env['PATH_INFO']
+        false
+      }
+    }
+    get "/css/main.css"
+    assert_equal 404, last_response.status
+    assert_css_dir_untouched
+  end
+
+  def test_public_location_option_is_expanded
+    local_opts = {public_location: 'other-public'}
+    local_app = Rack::SassC.new(inner_app, local_opts)
+    assert_equal ::File.expand_path('other-public'), local_app.opts[:public_location]
+    # Make sure the original opts hash is unchanged
+    assert_equal 'other-public', local_opts[:public_location]
+  end
+
+  def test_location_returns_expanded_path_in_public
+    local_opts = {public_location: 'other_public'}
+    local_app = Rack::SassC.new(inner_app, local_opts)
+    assert_equal ::File.join(::File.expand_path('other_public'), 'dir'), local_app.location(:dir)
+  end
+
+  def test_filepath_returns_expanded_path_in_public
+    local_opts = {public_location: 'other_public'}
+    local_app = Rack::SassC.new(inner_app, local_opts)
+    assert_equal ::File.join(::File.expand_path('other_public'), 'dir', 'main.sass'), local_app.filepath(:dir, :main, :sass)
+  end
+
+  def test_works_with_different_dirnames_and_syntax
+    @inner_app = inner_app_other
+    @app_options = {
+      public_location: 'other-public',
+      css_dirname: :stylesheets,
+      scss_dirname: :sassc,
+      syntax: :sass
+    }
+    get "/stylesheets/main.css"
+    assert_equal 200, last_response.status
+    assert_equal 'text/css', last_response.headers['Content-Type']
+    assert last_response.body[/body\{color:blue\}/]
+    assert last_response.body[/sourceMappingURL=main\.css\.map/]
+    assert_created_in_css_dir "main.css", "main.css.map"
+  end
+
+  private
+
+  # This will assert the files were created
+  # but also fail if other files where created that
+  # are not passed as argument. Therefore the list 
+  # of files created needs to be exhaustive.
+  def assert_created_in_css_dir *created_files
+    if @app_options.has_key?(:public_location) and @app_options.has_key?(:css_dirname)
+      possible_files = created_files.dup
+      path = "#{@app_options[:public_location]}/#{@app_options[:css_dirname]}"
+    else
+      possible_files = KEEP_IN_CSS_DIR + created_files
+      path = 'public/css'
+    end
+    assert_equal possible_files.sort, Dir.children(path).sort
+  end
+
+  # Sugar for legibility
+  def assert_css_dir_untouched
+    assert_created_in_css_dir
+  end
+
+end
+

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: rack-sassc
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Mickael Riga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sassc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !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: bundler
+  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'
+description: Rack middleware for SassC which process sass/scss files when in development
+  environment.
+email:
+- mig@mypeplum.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack-sassc.rb
+- lib/rack/sassc.rb
+- lib/rack/sassc/version.rb
+- rack-sassc.gemspec
+- test/other-public/sassc/main.sass
+- test/other-public/stylesheets/main.css
+- test/other-public/stylesheets/main.css.map
+- test/public/css/already.css
+- test/public/scss/main.scss
+- test/test_rack_sassc.rb
+homepage: https://github.com/mig-hub/rack-sassc
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Rack middleware for SassC
+test_files: []