RubyGems - slimline - Versions diffs - 0.1.6 - Mend

slimline 0.1.6

Files changed (9) hide show

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e691cb372c001d5942752407d73173453a7fa2c7
+  data.tar.gz: ccf5e09939fd898c0b94425fdb6f2a9af01bd808
+SHA512:
+  metadata.gz: 49f6a381821154bc35a4300e434b60f26c8ad20439693c76a529766bb70ea8bf49692bfe9f5593ad1ada3382e0d94c8f46827a86b0428f1823ccfa1f4ac91c4c
+  data.tar.gz: 4eaad94fc0e64827599d0c45f6f629130ed5621e7aa5de094d5f4239ddbac8cc0980f5b57e73be6ed6541b62cf7c2af7f1b43fae08ba622c41f23d0f1d3c1d08

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2018
+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 ADDED Viewed

@@ -0,0 +1,69 @@
+# Slimline
+A small basic helper to allow progressively loading images, Nothing really special this was done more as a test to myself to create a rails gem :)
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'slimline'
+```
+And then execute:
+```bash
+$ bundle
+```
+Or install it yourself as:
+```bash
+$ gem install slimline
+```
+Once installed to make sure that your images still work when javascript isn't active add the following to the head tag
+```erb
+class="<%= slimline_js_check_class %>"
+```
+Then in the `<html>` section before any css rendering enter:
+```erb
+  <%= slimline_js_check %>
+```
+# Usage
+Now you have installed the about, you will be able to call in the body the `slimine_image_tag` like:
+```erb
+<%= slimline_image_tag 'test.jpg', width: 1000, small_image: 'test_small.jpg', alt: "Hello World" %>
+```
+Below is a crude example how to use this:
+```erb
+<!DOCTYPE html>
+ <html class="<%= slimline_js_check_class %>">
+  <head>
+    <title>Slimline</title>
+    <%= csrf_meta_tags %>
+    <%= slimline_js_check %>
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </head>
+  <body>
+    <%= slimline_image_tag 'test.jpg', width: 1000, small_image: 'test_small.jpg', alt: "Hello World" %>
+  </body>
+ </html>
+```
+You are also able to add a srcset tag to the `slimline_image_tag` that will do srcsets too e.g:
+```erb
+<%= slimline_image_tag 'test.jpg', width: 1000, small_image: 'test_small.jpg', srcset: "<%= image_path 'test_x1.jpg' %> x1, <%= image_path 'test_x2' %> x2 ", alt: "Hello World" %>
+```
+## Contributing
+Tests are my next step in learning, so tests are currently not present.
+To contribute, fork, make your change and do a pull request.
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile ADDED Viewed

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Slimline'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+task default: :test

data/lib/slimline/railtie.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module Slimline
+  class Engine < ::Rails::Engine
+    initializer 'slimline.initialize' do
+      ActiveSupport.on_load(:action_view) do
+        include Slimline::ViewHelper
+      end
+    end
+  end
+end

data/lib/slimline/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Slimline
+  VERSION = '0.1.6'
+end

data/lib/slimline/view_helper.rb ADDED Viewed

@@ -0,0 +1,44 @@
+module Slimline
+  module ViewHelper
+    include ActionView::Context
+    include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::AssetTagHelper
+    def slimline_js_check_class
+      'slimline-no-js'
+    end
+    def slimline_js_check
+      content_tag :script do
+        raw 'document.documentElement.classList.remove("slimline-no-js");'
+      end
+    end
+    def slimline_image_tag(source, options = {} )
+      small_image = options.delete(:small_image)
+      srcset = options.delete(:srcset)
+      sizes = options.delete(:sizes)
+      data_options = options.delete(:data) || {}
+      new_options = options
+      new_options = new_options.merge(class: 'lazy')
+      if small_image
+        data_options = data_options.merge('src' => image_path(source))
+        new_source = small_image
+      else
+        new_source = source
+      end
+      data_options = data_options.merge('srcset' => srcset) if srcset
+      data_options = data_options.merge('sizes' => sizes) if sizes
+      new_options = new_options.merge(data: data_options)
+      image_tag(new_source, new_options) +
+        content_tag(:noscript) do
+          image_tag(source, options)
+        end
+    end
+  end
+end

data/lib/slimline.rb ADDED Viewed

@@ -0,0 +1,10 @@
+require "action_view"
+require "slimline/version"
+require "slimline/view_helper"
+require "slimline/railtie" if defined?(Rails)
+module Slimline
+end

metadata ADDED Viewed

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: slimline
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Matthew Deloughry
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2018-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Give a nice helper to progressively load images
+email:
+- matt@deloughry.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/slimline.rb
+- lib/slimline/railtie.rb
+- lib/slimline/version.rb
+- lib/slimline/view_helper.rb
+homepage: https://deloughry.co.uk
+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.2.5
+signing_key:
+specification_version: 4
+summary: Give a nice helper to progressively load images
+test_files: []