attachment_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0cf8951a9aee20e8c28cf899ec617bbb42a1eaa7
+  data.tar.gz: 3d53284fb7b13fef431ddc0b8008a90bee97eb3d
+SHA512:
+  metadata.gz: a0207a12a87a4a9005474e2e7662b00e00779912b2fd463b7e3f7a4bb82b4437bd277003b90bfd043c66819a177fcf08afc96fe16d16631e038dfc16f77622a6
+  data.tar.gz: 5fcd1e47c48941527e85fc21a9a282375ee6643f806850ca02c5226bf2ab256d3a90f3b66b24d5c3b6171899a133aefd1a369d99908e097930df360e198d2c38

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/spec/examples.txt
+
+*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require gem_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 jiangzhi.xie
+
+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,93 @@
+# AttachmentPath
+
+Some Helper methods to generate url and get filename from attachment path
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attachment_path'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attachment_path
+
+## Usage
+
+### Setup
+
+```
+AttachmentHelper.attachment_host = 'http://myhost.com'
+```
+
+### Define attachments
+
+```
+class Topic
+  include AttachmentHelper
+
+  has_attachments [:logo_path, {size: '100x100'}], :pdf_path, :image_paths
+
+  def logo_path
+    'uploads/a.png'
+  end
+
+  def pdf_path
+    'http://hello.com/assets/a.pdf'
+  end
+
+  def image_paths
+    ['a.png', 'http://other.com/b.png']
+  end
+end
+```
+
+### helper methods
+
+```
+topic = Topic.new
+```
+
+Helper methods for path
+
+```
+topic.logo_url # => 'http://myhost.com/uploads/a.png?size=100x100'
+topic.logo_url(size: 200, t: 123) # => 'http://myhost.com/uploads/a.png?size=200&t=123'
+topic.logo_filename # => 'a.png'
+```
+
+Helper methods for url
+
+```
+topic.pdf_url # => 'http://hello.com/assets/a.pdf'
+topic.pdf_url(foo: :bar) # => 'http://hello.com/assets/a.pdf?foo=bar'
+topic.pdf_filename # => 'a.pdf'
+```
+
+Helper methods for a list
+
+```
+topic.image_urls # => ['http://hello/a.png', 'http://other.com/b.png']
+topic.image_urls(a: :foo) # => ['http://hello/a.png?a=foo', 'http://other.com/b.png?a=foo']
+topic.image_filenames # => ['a.png', 'b.png']
+```
+
+## 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/xiejiangzhi/attachment_helper.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/attachment_helper.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "attachment_helper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "attachment_helper"
+  spec.version       = AttachmentHelper::VERSION
+  spec.authors       = ["jiangzhi.xie"]
+  spec.email         = ["xiejiangzhi@gmail.com"]
+
+  spec.summary       = %q{Some attachment helpers for attachment path}
+  spec.description   = %q{Generate url and get filename from attachment path}
+  spec.homepage      = "https://github.com/xiejiangzhi/attachment_helper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", '~> 0.10.4'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "attachment_path"
+
+# 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(__FILE__)

data/bin/setup

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

data/examples/benchmark.rb

@@ -0,0 +1,77 @@
+require 'attachment_helper'
+require 'benchmark'
+
+AttachmentHelper.attachment_host = 'http://myhost.com'
+
+class Topic
+  include AttachmentHelper
+
+  has_attachments [:logo_path, {size: '100x100'}], :pdf_path, :image_paths
+
+  def logo_path
+    'uploads/a.png'
+  end
+
+  def pdf_path
+    'http://hello.com/assets/a.pdf'
+  end
+
+  def image_paths
+    ['a.png', 'http://other.com/b.png']
+  end
+end
+
+topic = Topic.new
+
+total_times = 100000
+puts "Times: #{total_times}"
+
+Benchmark.bm do |x|
+  x.report('Run logo_url') do
+    total_times.times do
+      topic.logo_url
+    end
+  end
+
+  x.report('Run logo_url(opts)') do
+    total_times.times do
+      topic.logo_url(foo: :bar, long: 'this_is_some_long_text')
+    end
+  end
+
+  x.report('Run logo_filename') do
+    total_times.times do
+      topic.logo_filename
+    end
+  end
+
+  x.report('Run pdf_url') do
+    total_times.times do
+      topic.pdf_url
+    end
+  end
+
+  x.report('Run pdf_url(opts)') do
+    total_times.times do
+      topic.pdf_url(foo: :bar, long: 'this_is_some_long_text')
+    end
+  end
+
+  x.report('Run image_urls') do
+    total_times.times do
+      topic.image_urls
+    end
+  end
+
+  x.report('Run image_urls(opts)') do
+    total_times.times do
+      topic.image_urls(foo: :bar, long: 'this_is_some_long_text')
+    end
+  end
+
+  x.report('Run image_filenames') do
+    total_times.times do
+      topic.image_filenames
+    end
+  end
+end

data/examples/custom_url.rb

@@ -0,0 +1,39 @@
+require 'attachment_helper'
+
+AttachmentHelper.attachment_host = 'http://myhost.com'
+
+module ExtAttachmentURL
+  def get_url_by_path(path, opts = {})
+    if path =~ /https?:\/\/private\.com/
+      super(path, opts.merge(token: 'signed_token'))
+    else
+      super
+    end
+  end
+end
+
+AttachmentHelper.singleton_class.prepend(ExtAttachmentURL)
+
+class Topic
+  include AttachmentHelper
+
+  has_attachments [:logo_path, {size: '100x100'}], :pdf_path, :image_paths
+
+  def logo_path
+    'http://private.com/a.png'
+  end
+
+  def image_paths
+    ['a.png', 'http://private.com/b.png']
+  end
+end
+
+topic = Topic.new
+
+puts topic.logo_url
+puts topic.logo_url(size: 200, t: 123)
+
+puts topic.image_urls
+puts topic.image_urls(size: 200, t: 123)
+
+

data/examples/getting_start.rb

@@ -0,0 +1,36 @@
+require 'attachment_helper'
+
+AttachmentHelper.attachment_host = 'http://myhost.com'
+
+class Topic
+  include AttachmentHelper
+
+  has_attachments [:logo_path, {size: '100x100'}], :pdf_path, :image_paths
+
+  def logo_path
+    'uploads/a.png'
+  end
+
+  def pdf_path
+    'http://hello.com/assets/a.pdf'
+  end
+
+  def image_paths
+    ['a.png', 'http://other.com/b.png']
+  end
+end
+
+topic = Topic.new
+
+puts topic.logo_url
+puts topic.logo_url(size: 200, t: 123)
+puts topic.logo_filename
+
+puts topic.pdf_url
+puts topic.pdf_url(foo: :bar)
+puts topic.pdf_filename
+
+puts topic.image_urls.inspect
+puts topic.image_urls(a: :foo).inspect
+puts topic.image_filenames.inspect
+

data/lib/attachment_helper.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "attachment_helper/class_methods"
+require "attachment_helper/version"
+
+require 'uri'
+
+module AttachmentHelper
+  class << self
+    attr_accessor :attachment_host
+
+    def included(cls)
+      cls.extend(AttachmentHelper::ClassMethods)
+    end
+
+    def attachment_host
+      @attachment_host ||= 'http://please-set-attachment-host.com'
+    end
+
+
+    def symbolize_keys(hash)
+      hash.each_with_object({}) {|kv, r| r[(kv.first.to_sym rescue kv.first)] = kv.last }
+    end
+
+    def get_url_by_path(path, options = {})
+      return if path.nil?
+      query = options.empty? ? '' : "?#{URI.encode_www_form(options)}"
+      if path =~ /^http/
+        "#{path}#{query}"
+      else
+        "#{AttachmentHelper.attachment_host}/#{path}#{query}"
+      end
+    end
+
+    def get_filename_by_path(path)
+      return if path.nil?
+      path.split('/').last
+    end
+  end
+end

data/lib/attachment_helper/class_methods.rb

@@ -0,0 +1,72 @@
+# Attachment Helper
+#
+# Specify some attachment reader:
+#   # avatar_path: a string
+#   # pdf_paths: a array of string
+#   has_attachments :avatar_path, :pdf_paths
+#   # or
+#   has_attachments [:avatar_path, {size: '100x100'}], :pdf_paths
+#
+# Generated Methods:
+#   avatar_url
+#   avatar_filename
+#   pdf_urls
+#   pdf_filenames
+
+module AttachmentHelper
+  module ClassMethods
+    # field => options
+    def has_attachments(*fields)
+      fields.each do |field, opts|
+        default_opts = AttachmentHelper.symbolize_keys(opts || {})
+        case field
+        when /_paths$/
+          define_attachments_methods(field.to_s, default_opts)
+        else
+          define_attachment_methods(field.to_s, default_opts)
+        end
+      end
+    end
+
+    def define_attachment_methods(field, default_opts = {})
+      prefix = field.gsub(/_path$/, '')
+      m_url, m_filename = ["#{prefix}_url", "#{prefix}_filename"]
+
+      # {name}_url
+      define_method(m_url) do |options = {}|
+        val = self.public_send(field)
+
+        AttachmentHelper.get_url_by_path(
+          val, default_opts.merge(AttachmentHelper.symbolize_keys(options))
+        )
+      end
+
+      # attachment/{uuid}/filename.pdf return filename.pdf
+      define_method(m_filename) do
+        val = self.public_send(field)
+        AttachmentHelper.get_filename_by_path(val)
+      end
+    end
+
+    def define_attachments_methods(field, default_opts)
+      prefix = field.gsub(/_paths$/, '')
+      m_urls, m_filenames = ["#{prefix}_urls", "#{prefix}_filenames"]
+
+      define_method(m_urls) do |options = {}|
+        val = self.public_send(field)
+        return nil if val.nil?
+        Array(val).map do |v|
+          AttachmentHelper.get_url_by_path(
+            v, default_opts.merge(AttachmentHelper.symbolize_keys(options))
+          )
+        end
+      end
+
+      define_method(m_filenames) do
+        val = self.public_send(field)
+        return nil if val.nil?
+        Array(val).map { |v| AttachmentHelper.get_filename_by_path(v) }
+      end
+    end
+  end
+end

data/lib/attachment_helper/version.rb

@@ -0,0 +1,3 @@
+module AttachmentHelper
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: attachment_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jiangzhi.xie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+description: Generate url and get filename from attachment path
+email:
+- xiejiangzhi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- attachment_helper.gemspec
+- bin/console
+- bin/setup
+- examples/benchmark.rb
+- examples/custom_url.rb
+- examples/getting_start.rb
+- lib/attachment_helper.rb
+- lib/attachment_helper/class_methods.rb
+- lib/attachment_helper/version.rb
+homepage: https://github.com/xiejiangzhi/attachment_helper
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Some attachment helpers for attachment path
+test_files: []