named_variant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aae2ca4f1de62ee57337c10488954ecc89da34a24db1fc3e80da9be699bed3ed
+  data.tar.gz: 1a8c5519cff74ee34d3c780feb2b42263c050431980712f699b40a70eb6877c2
+SHA512:
+  metadata.gz: bb3406e05f711c80fcbaa6edc0a136f3a8da2d5d821def3c2a401d7ff16ab8b9119796df299a9e7c27b3c8a1705b6b6fbe0b8da2571d196acc3a5a8c5914583d
+  data.tar.gz: cd077ff4bc3ea76fb4d91c6c1ee34b377b1d0d5c6c7ab416d5d56680261cef29fead4681c657640483bfa8ef14be75215a12eb352b2db2db16f33036494aadda

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Yukito Ito
+
+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,51 @@
+# NamedVariant
+
+Make ActiveStorage's variant named and configurable.
+
+Usual process is
+
+```ruby
+class User < ActiveRecord::Base
+  has_one_attached :avatar
+end
+```
+
+and view.
+
+```ruby
+= image_tag(user.avatar.variant(resize: "100x100", monochrome: true, flip: "-90").processed)
+```
+
+It's annoying, and sometimes not DRY. NamedVarient gives a solution.
+
+```ruby
+class User < ActiveRecord::Base
+  has_one_attached :avatar
+
+  variant_name :monochrome, resize: "100x100", monochrome: true, flip: "-90"
+end
+```
+
+```ruby
+= image_tag(user.avatar.variant(:monochrome).processed)
+# only user's attachment can call `monochrome` variant.
+```
+
+## Installation
+
+```ruby
+gem 'named_variant'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Todo
+
+- [ ] scoped variant name support
+- [ ] config file support
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rspec/core/rake_task"
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w[--format documentation --colour]
+end
+
+task :default => "spec"

data/lib/named_variant.rb

@@ -0,0 +1,39 @@
+require "named_variant/railtie"
+
+module NamedVariant
+  mattr_reader :named_variants, default: {}
+
+  module VariantExtension
+    # prepend ActiveStorage::Blob::Representable#variant
+    # https://github.com/rails/rails/blob/3c823271af52a61e825123def170fe2187057577/activestorage/app/models/active_storage/blob/representable.rb#L28
+    def variant(args)
+      if args.is_a?(Symbol)
+        # self is ActiveStorage::Attached::One
+        named_variant = ::NamedVariant.find_named_variant_for(klass: self.record.class, sym: args) || raise(VariantNotFound)
+        return super(named_variant.to_h)
+      end
+
+      super
+    end
+  end
+
+  module ActiveRecordExtension
+    def variant_name(name, **opts)
+      ::NamedVariant.add_variant("#{self}/#{name}", opts) ## key looks like: User/xsmall
+    end
+  end
+
+  def self.find_named_variant_for(klass: nil, sym:)
+    # NOTE: name params
+    named_variants["#{klass}/#{sym}"] || named_variants[sym.to_s]
+  end
+
+  def self.add_variant(name, opts)
+    named_variants[name.to_s] = Variant.new(opts)
+  end
+
+  class VariantNotFound < StandardError
+  end
+end
+
+require "named_variant/variant"

data/lib/named_variant/railtie.rb

@@ -0,0 +1,11 @@
+module NamedVariant
+  class Railtie < ::Rails::Railtie
+    ActiveSupport.on_load(:active_record) do
+      ActiveRecord::Base.extend ::NamedVariant::ActiveRecordExtension
+    end
+
+    config.after_initialize do
+      ActiveStorage::Attached::One.prepend ::NamedVariant::VariantExtension
+    end
+  end
+end

data/lib/named_variant/variant.rb

@@ -0,0 +1,13 @@
+module NamedVariant
+  class Variant
+    attr_reader :options
+
+    def initialize(options)
+      @options = options
+    end
+
+    def to_h
+      options
+    end
+  end
+end

data/lib/named_variant/version.rb

@@ -0,0 +1,3 @@
+module NamedVariant
+  VERSION = "0.1.0".freeze
+end

data/lib/tasks/named_variant_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :named_variant do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: named_variant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yukito Ito
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  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: onkcop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: sqlite3
+  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: Make ActiveStorage's variant named and configurable
+email:
+- yukibukiyou@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/named_variant.rb
+- lib/named_variant/railtie.rb
+- lib/named_variant/variant.rb
+- lib/named_variant/version.rb
+- lib/tasks/named_variant_tasks.rake
+homepage: https://github.com/ykpythemind/named_variant
+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: Named ActiveStorage's variant
+test_files: []