lotus-shrine 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 2a2da205393023fa9e8512e7476906acbe111c5d
4
+ data.tar.gz: 8be181f43ef6025e124c2a56b2c490423c1cd6dd
5
+ SHA512:
6
+ metadata.gz: c5f0d89237f8ca2f9a3adf969802c94510fdacac316bf3a3efa9f0317681181381ee39f0f50cf714534243bd91fbded6b5cfb854fe114ede1a9f8623c6352b1d
7
+ data.tar.gz: 11891b8faa00fc09790ea7ef4c400cc2fa047444c5ac50b6ab9e1a15b5b29b6253d2f8d3926cc773859cb31ba538f4f837af2743ede31fdce9afcf8a70cfaa33
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /spec/tmp/
10
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.3
4
+ before_install: gem install bundler -v 1.10.6
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in lotus-shrine.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 Paweł Świątkowski
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,85 @@
1
+ # Lotus::Shrine
2
+
3
+ This gem aims at providing support for [Shrine](https://github.com/janko-m/shrine) uploader in Lotus applications. It also tries to be as simple as possible, without polluting the world around.
4
+
5
+ For now it's not released to RubyGems so please, use the git version. I promise to release as soon as I think it makes any sense :wink:
6
+
7
+ [![Build Status](https://travis-ci.org/katafrakt/lotus-shrine.svg)](https://travis-ci.org/katafrakt/lotus-shrine)
8
+
9
+ ## Installation
10
+
11
+ Add this line to your application's Gemfile:
12
+
13
+ ```ruby
14
+ gem 'lotus-shrine', github: 'katafrakt/lotus-shrine'
15
+ ```
16
+
17
+ And then execute:
18
+
19
+ $ bundle
20
+
21
+ ## Usage
22
+
23
+ Setup Shrine with `lotus` plugin enabled. Check [Shrine's repository](https://github.com/janko-m/shrine) for more detailed description of the process.
24
+
25
+ ```ruby
26
+ class ImageAttachment < Shrine
27
+ plugin :lotus
28
+ end
29
+ ```
30
+
31
+ Then, in your repository add (assuming your attachment is `avatar`):
32
+
33
+ ```ruby
34
+ extend ImageAttachment.repository(:avatar)
35
+ ```
36
+
37
+ And in your entity:
38
+
39
+ ```ruby
40
+ include ImageAttachment[:avatar]
41
+ ```
42
+
43
+ To use validations, enable them during setup of the plugin:
44
+
45
+ ```ruby
46
+ class ImageAttachment < Shrine
47
+ plugin :lotus, validations: true
48
+ end
49
+ ```
50
+
51
+ And you can write some validation code. For example:
52
+
53
+ ```ruby
54
+ class ImageAttachment < Shrine
55
+ plugin :validation_helpers
56
+ plugin :determine_mime_type
57
+ plugin :lotus, validations: true
58
+
59
+ Attacher.validate do
60
+ validate_max_size 180_000, message: "is too large (max is 2 MB)"
61
+ validate_mime_type_inclusion ["image/jpg", "image/jpeg"]
62
+ end
63
+ end
64
+ ```
65
+
66
+ Remember that you have to call `valid?` or `validate` yourself. There is not as much magic in Lotus as it is in Rails :wink:
67
+
68
+ For inspiration look at [the specs](https://github.com/katafrakt/lotus-shrine/tree/master/spec/lotus) or [example repo](https://github.com/katafrakt/lotus-shrine-example).
69
+
70
+ ## Development
71
+
72
+ 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.
73
+
74
+ 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).
75
+
76
+ ## Contributing
77
+
78
+ Bug reports and pull requests are welcome on GitHub at https://github.com/katafrakt/lotus-shrine.
79
+
80
+
81
+ ## License
82
+
83
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
84
+
85
+ Cat images (used in tests) are public domain taken from [Wikimedia Commons](http://commons.wikimedia.org).
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "lotus/shrine"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,2 @@
1
+ require "lotus/shrine/version"
2
+ require 'shrine/plugins/lotus'
@@ -0,0 +1,5 @@
1
+ module Lotus
2
+ module Shrine
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
@@ -0,0 +1,69 @@
1
+ require 'shrine'
2
+
3
+ class Shrine
4
+ module Plugins
5
+ module Lotus
6
+ def self.configure(uploader, validations: nil)
7
+ uploader.opts[:lotus_validations] = validations
8
+ end
9
+
10
+ module AttachmentMethods
11
+ def initialize(name)
12
+ super
13
+
14
+ if shrine_class.opts[:lotus_validations]
15
+ module_eval <<-RUBY, __FILE__, __LINE__ + 1
16
+ def validate
17
+ super
18
+ #{name}_attacher.errors.each do |message|
19
+ errors.add(:#{name}, message)
20
+ end
21
+ end
22
+ RUBY
23
+ end
24
+ end
25
+ end
26
+
27
+ module ClassMethods
28
+ def repository(name)
29
+ RepositoryMethods.new(name)
30
+ end
31
+ end
32
+
33
+ class RepositoryMethods < Module
34
+ def initialize(name)
35
+ module_eval <<-RUBY, __FILE__, __LINE__ + 1
36
+ def create(entity)
37
+ save_#{name}_attachment(entity) { super }
38
+ end
39
+ def update(entity)
40
+ save_#{name}_attachment(entity) { super }
41
+ end
42
+ def persist(entity)
43
+ save_#{name}_attachment(entity) { super }
44
+ end
45
+ def delete(entity)
46
+ delete_#{name}_attachment(entity) { super }
47
+ end
48
+
49
+ private
50
+ def save_#{name}_attachment(entity)
51
+ entity.#{name}_attacher.save
52
+
53
+ entity.#{name}_attacher.replace
54
+ entity.#{name}_attacher._promote
55
+ yield
56
+ end
57
+
58
+ def delete_#{name}_attachment(entity)
59
+ yield
60
+ entity.#{name}_attacher.destroy
61
+ end
62
+ RUBY
63
+ end
64
+ end
65
+ end
66
+
67
+ register_plugin(:lotus, Lotus)
68
+ end
69
+ end
@@ -0,0 +1,30 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'lotus/shrine/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "lotus-shrine"
8
+ spec.version = Lotus::Shrine::VERSION
9
+ spec.authors = ["Paweł Świątkowski"]
10
+ spec.email = ["inquebrantable@gmail.com"]
11
+
12
+ spec.summary = %q{Support for Shrine gem in Lotus framework}
13
+ spec.description = %q{Support for Shrine gem in Lotus framework}
14
+ spec.homepage = "http://github.com/katafrakt/lotus-shrine"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_dependency 'shrine'
23
+ spec.add_dependency 'lotus-model'
24
+
25
+ spec.add_development_dependency "bundler", "~> 1.10"
26
+ spec.add_development_dependency "rake", "~> 10.0"
27
+ spec.add_development_dependency "rspec"
28
+ spec.add_development_dependency "json"
29
+ spec.add_development_dependency "lotus-validations"
30
+ end
metadata ADDED
@@ -0,0 +1,155 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: lotus-shrine
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Paweł Świątkowski
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-12-23 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: shrine
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: lotus-model
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.10'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.10'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: json
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: lotus-validations
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ description: Support for Shrine gem in Lotus framework
112
+ email:
113
+ - inquebrantable@gmail.com
114
+ executables: []
115
+ extensions: []
116
+ extra_rdoc_files: []
117
+ files:
118
+ - ".gitignore"
119
+ - ".rspec"
120
+ - ".travis.yml"
121
+ - Gemfile
122
+ - LICENSE.txt
123
+ - README.md
124
+ - Rakefile
125
+ - bin/console
126
+ - bin/setup
127
+ - lib/lotus/shrine.rb
128
+ - lib/lotus/shrine/version.rb
129
+ - lib/shrine/plugins/lotus.rb
130
+ - lotus-shrine.gemspec
131
+ homepage: http://github.com/katafrakt/lotus-shrine
132
+ licenses:
133
+ - MIT
134
+ metadata: {}
135
+ post_install_message:
136
+ rdoc_options: []
137
+ require_paths:
138
+ - lib
139
+ required_ruby_version: !ruby/object:Gem::Requirement
140
+ requirements:
141
+ - - ">="
142
+ - !ruby/object:Gem::Version
143
+ version: '0'
144
+ required_rubygems_version: !ruby/object:Gem::Requirement
145
+ requirements:
146
+ - - ">="
147
+ - !ruby/object:Gem::Version
148
+ version: '0'
149
+ requirements: []
150
+ rubyforge_project:
151
+ rubygems_version: 2.4.5.1
152
+ signing_key:
153
+ specification_version: 4
154
+ summary: Support for Shrine gem in Lotus framework
155
+ test_files: []