assets_deployer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a2fbff0dd0f4fdce8796030dd461a21e2a1effa
-  data.tar.gz: 9ee83f5080b956a53032e594486ab05a999b28b5
+  metadata.gz: ed1caa68bb86b53fcf9383ddf0a6590e279fdbb7
+  data.tar.gz: 8a1e18f651adec31f4b544d1df683269539c7cc4
 SHA512:
-  metadata.gz: 002dd5e527556600c58275694d40914f52ff907502eb160041dbacf2c74ada3853713b9598b1f61e521c8805468b5c5861dec1f96ed3ba30b1c6c74c76ac7e1d
-  data.tar.gz: 116a41aba91823a3b28b9819f16abebc223d9488e5a350d00cd9222d2be23853f271fefe4c0e7993656ec4f7582036f68bdcf2fa5be9c2a2b3e9c715ef19f1c4
+  metadata.gz: 5a07b9b9d0a04432e093aa7bc4cf43d7c9cee0ff7b17bb033d1e99530546c20c79d9ac106a61453c41e076c7d9dc05131ea4aabfde2cd58a30dea043b6387e19
+  data.tar.gz: 7f1a182179ba9b5c270fcd5f9604a0209bc1dee4a92ad14af1d4e237eafa06594a9dc9fd5f5e6f989f5ba334c5035f624f2ca81253c8438b31224adb8d258877

data/README.md

@@ -1,8 +1,5 @@
 # AssetsDeployer
-Short description and motivation.
-
-## Usage
-How to use my plugin.
+Asset files deployer for rails application.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,8 +18,30 @@ Or install it yourself as:
 $ gem install assets_deployer
 ```
 
-## Contributing
-Contribution directions go here.
+## Usage
+
+### Rails
+Add initializer at `config/iniitializers/assets_deployer.rb`
+```rb
+AssetsDeployer.configure do |config|
+  config.assets.root_path   = Rails.root.join('public')
+  config.assets.prefix_paths = ['assets', 'packs']
+  config.assets.ignore_paths = ['packs/manifest.json']
+  # your storage service configurations
+  config.storage.name = 'S3'
+  config.storage.options[:bucket]     = 'bucket_name'
+  config.storage.options[:prefix_key] = 'project_name'
+  # credentials
+  # Also, you can use environment variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY) or instance profile credentials
+  config.storage.credentials[:access_key_id]     = 'aws_access_key_id'
+  config.storage.credentials[:secret_access_key] = 'aws_secret_access_key'
+end
+```
+
+then you can use this rails command
+```console
+$ bundle exec rails assets:precompile assets:deploy
+```
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/assets_deployer.rb

@@ -4,7 +4,13 @@ require 'assets_deployer/storage_builder'
 
 module AssetsDeployer
   def self.run
-    deployer = Deployer.new(storage: storage, root_path: config.assets_root_path, prefixes: config.assets_prefixes)
+    deployer = Deployer.new(
+      storage: storage,
+      root_path: config.assets.root_path,
+      prefix_paths: config.assets.prefix_paths,
+      ignore_paths: config.assets.ignore_paths
+    )
+
     deployer.run
   end
 
@@ -18,7 +24,6 @@ module AssetsDeployer
 
   def self.storage
     builder = StorageBuilder.new(
-      platform: config.storage.platform,
       name: config.storage.name,
       credentials: config.storage.credentials,
       options: config.storage.options

data/lib/assets_deployer/configuration.rb

@@ -1,16 +1,26 @@
 module AssetsDeployer
   class Configuration
-    attr_accessor :storage,
-                  :assets_root_path,
-                  :assets_prefixes
+    attr_accessor :assets,
+                  :storage
 
-    class StorageConfiguration < Struct.new(:platform, :name, :credentials, :options)
+    class AssetsConfiguration < Struct.new(:root_path, :prefix_paths, :ignore_paths)
+      def initialize
+        self.prefix_paths = ['assets']
+        self.ignore_paths = []
+      end
+    end
+
+    class StorageConfiguration < Struct.new(:name, :credentials, :options)
       def initialize
         self.credentials = {}
         self.options = {}
       end
     end
 
+    def assets
+      @assets ||= AssetsConfiguration.new
+    end
+
     def storage
       @storage ||= StorageConfiguration.new
     end

data/lib/assets_deployer/deployer.rb

@@ -2,10 +2,11 @@ require 'assets_deployer/asset_file'
 
 module AssetsDeployer
   class Deployer
-    def initialize(storage:, root_path:, prefixes:)
+    def initialize(storage:, root_path:, prefix_paths:, ignore_paths:)
       @storage = storage
       @root_path = root_path
-      @prefixes = prefixes
+      @prefix_paths = prefix_paths
+      @ignore_paths = ignore_paths.map { |path| File.join(root_path, path) }
     end
 
     def run
@@ -15,9 +16,9 @@ module AssetsDeployer
     private
 
     def files
-      @files ||= @prefixes.flat_map do |prefix|
+      @files ||= @prefix_paths.flat_map do |prefix|
         Dir.glob(@root_path.join(prefix).join('**', '**')).map do |path|
-          AssetFile.new(prefix, path) if Pathname.new(path).file?
+          AssetFile.new(prefix, path) if Pathname.new(path).file? && !@ignore_paths.include?(path)
         end
       end.compact
     end

data/lib/assets_deployer/storage_builder.rb

@@ -6,16 +6,15 @@ module AssetsDeployer
     class InvalidStorageError < StandardError
     end
 
-    def initialize(platform:, name:, credentials:, options:)
-      @platform = platform
+    def initialize(name:, credentials:, options:)
       @name = name
       @credentials = credentials
       @options = options
     end
 
     def build
-      case [@platform, @name]
-      when ['AWS', 'S3']
+      case @name
+      when 'S3'
         Storage::AwsS3.new(
           credentials: @credentials,
           bucket: @options[:bucket],

data/lib/assets_deployer/version.rb

@@ -1,3 +1,3 @@
 module AssetsDeployer
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: assets_deployer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Shota Iguchi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-28 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails