hanami-shrine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a4b2d769b9c4ae74aa70fb0123ec6c946d99c9a
+  data.tar.gz: 7697d45f9ece1f8c340135b90499448646427d99
+SHA512:
+  metadata.gz: ce937ea318c92b34618915753a11d39f6244838675bb931f0f14b45df641c3a571d39b23ee56556495fde30e1dff0ddb7c30030144527292e191f9638338ed8a
+  data.tar.gz: 0cd4719b771e3810eb7c651244ff77560077477ce12aeae2781da312701c1e51f44add62a54c8801d9c1f5800dbdfbebda8e5d668a995810b908ca32d48633f4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/tmp/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Paweł Świątkowski
+
+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,84 @@
+# Hanami::Shrine
+
+This gem aims at providing support for [Shrine](https://github.com/janko-m/shrine) uploader in Hanami applications. It also tries to be as simple as possible, without polluting the world around.
+
+[![Build Status](https://travis-ci.org/katafrakt/hanami-shrine.svg)](https://travis-ci.org/katafrakt/hanami-shrine)
+[![Gem Version](https://badge.fury.io/rb/hanami-shrine.svg)](https://badge.fury.io/rb/hanami-shrine)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hanami-shrine'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Setup Shrine with `hanami` plugin enabled. Check [Shrine's repository](https://github.com/janko-m/shrine) for more detailed description of the process.
+
+```ruby
+class ImageAttachment < Shrine
+  plugin :hanami
+end
+```
+
+Then, in your repository add (assuming your attachment is `avatar`):
+
+```ruby
+extend ImageAttachment.repository(:avatar)
+```
+
+And in your entity:
+
+```ruby
+include ImageAttachment[:avatar]
+```
+
+To use validations, enable them during setup of the plugin:
+
+```ruby
+class ImageAttachment < Shrine
+  plugin :hanami, validations: true
+end
+```
+
+And you can write some validation code. For example:
+
+```ruby
+class ImageAttachment < Shrine
+  plugin :validation_helpers
+  plugin :determine_mime_type
+  plugin :hanami, validations: true
+
+  Attacher.validate do
+    validate_max_size 180_000, message: "is too large (max is 2 MB)"
+    validate_mime_type_inclusion ["image/jpg", "image/jpeg"]
+  end
+end
+```
+
+Remember that you have to call `valid?` or `validate` yourself. There is not as much magic in Hanami as it is in Rails :wink:
+
+For inspiration look at [the specs](https://github.com/katafrakt/hanami-shrine/tree/master/spec/hanami) or [example repo](https://github.com/katafrakt/hanami-shrine-example).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/katafrakt/hanami-shrine.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Cat images (used in tests) are public domain taken from [Wikimedia Commons](http://commons.wikimedia.org).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hanami/shrine"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hanami-shrine.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hanami/shrine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hanami-shrine"
+  spec.version       = Hanami::Shrine::VERSION
+  spec.authors       = ["Paweł Świątkowski"]
+  spec.email         = ["inquebrantable@gmail.com"]
+
+  spec.summary       = %q{Support for Shrine gem in Hanami framework}
+  spec.description   = %q{Support for Shrine gem in Hanami framework}
+  spec.homepage      = "http://github.com/katafrakt/hanami-shrine"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'shrine'
+  spec.add_dependency 'hanami-model'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "json"
+  spec.add_development_dependency "hanami-validations"
+end

data/lib/hanami/shrine.rb

@@ -0,0 +1,2 @@
+require "hanami/shrine/version"
+require 'shrine/plugins/hanami'

data/lib/hanami/shrine/version.rb

@@ -0,0 +1,5 @@
+module Hanami
+  module Shrine
+    VERSION = "0.1.0"
+  end
+end

data/lib/shrine/plugins/hanami.rb

@@ -0,0 +1,69 @@
+require 'shrine'
+
+class Shrine
+  module Plugins
+    module Hanami
+      def self.configure(uploader, validations: nil)
+        uploader.opts[:hanami_validations] = validations
+      end
+
+      module AttachmentMethods
+        def initialize(name)
+          super
+
+          if shrine_class.opts[:hanami_validations]
+            module_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def validate
+                super
+                #{name}_attacher.errors.each do |message|
+                  errors.add(:#{name}, message)
+                end
+              end
+            RUBY
+          end
+        end
+      end
+
+      module ClassMethods
+        def repository(name)
+          RepositoryMethods.new(name)
+        end
+      end
+
+      class RepositoryMethods < Module
+        def initialize(name)
+          module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def create(entity)
+              save_#{name}_attachment(entity) { super }
+            end
+            def update(entity)
+              save_#{name}_attachment(entity) { super }
+            end
+            def persist(entity)
+              save_#{name}_attachment(entity) { super }
+            end
+            def delete(entity)
+              delete_#{name}_attachment(entity) { super }
+            end
+
+            private
+            def save_#{name}_attachment(entity)
+              entity.#{name}_attacher.save
+
+              entity.#{name}_attacher.replace
+              entity.#{name}_attacher._promote
+              yield
+            end
+
+            def delete_#{name}_attachment(entity)
+              yield
+              entity.#{name}_attacher.destroy
+            end
+          RUBY
+        end
+      end
+    end
+
+    register_plugin(:hanami, Hanami)
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: hanami-shrine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paweł Świątkowski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shrine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hanami-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: json
+  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: hanami-validations
+  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: Support for Shrine gem in Hanami framework
+email:
+- inquebrantable@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hanami-shrine.gemspec
+- lib/hanami/shrine.rb
+- lib/hanami/shrine/version.rb
+- lib/shrine/plugins/hanami.rb
+homepage: http://github.com/katafrakt/hanami-shrine
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Support for Shrine gem in Hanami framework
+test_files: []
+has_rdoc: