icomoon-cli 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a16aae804f9d6388ccd24169bbb87e9d94737238
-  data.tar.gz: c9502529623e5557593947268a8799b4f208bfc0
+  metadata.gz: 54e58814511a2c9deb563392dd4e81f3cd6bf09e
+  data.tar.gz: 50dcc0a2ccdef3347f25886958d98eb3bd0cb4ce
 SHA512:
-  metadata.gz: 34307bd99ec210bc6456d7b5d35bdf74d1a49a6ba90e9b59aa44635b9ee83c4bd46c1e4af5e2a52c48fc483fb1dfe67991707bb031661a4506df9c657a1c933b
-  data.tar.gz: aba80d9a9e24334384653fbadd7ca3e1f5827e1a1c696c0c97b98b0643a88309c6452d3d34e002c8bcfde00c611b21084b3c2da72fa48aad5dba8ec6d0453099
+  metadata.gz: b197ef77ff83ec3bbbd7fa7c67e2494bcd9e7f44e816889ec049adac49345849f2c1455e22dffa7ef2cdd09fc430cb74049ccd63a525f9aa3272104e63e2af17
+  data.tar.gz: 96fa42273490b74a02d4ae8e4cf01da98df6cfa677f7f41b5e0ad9846c9a81388f01ec6999d7367dc331dc0a674d7e44c1c324072ba8e192770926efd4335c29

data/README.md

@@ -1,18 +1,31 @@
 # Icomoon
 
-Icomoon gem helps to update icomoon assets via command line. this gem will automate all the steps to be done while we update icomoon's icon list.
+Icomoon gem helps to update icomoon's icons via command line. this gem will automate all the steps to be done while we update icomoon's icon set.
 
 ## Installation
 
-
-    $ gem install icomoon
+    $ gem install icomoon-cli
 
 ## Usage
 
+- Open [Iconmoon App](https://icomoon.io/app/#/projects)
+- Follow this [Documentation](https://icomoon.io/docs.html) to know how to get started with icomoon.
+- Once you have created icon set download the icon set.
+- By default this gem assume it's Rails Application hence will be importing to our default rails assets folder and will be keeping a copy of `selection.json` file in our applications **public folder**. if you want to customise the path you can create a file name `.icomoon.yml` add the key value pair as follows in the root of project directory.
+
+```yml
+working_directory: "/vendor/icofont/tmp"
+font_directory: "/vendor/icofont/fonts"
+stylesheet_directory: "/vendor/icofont/stylesheets"
+stylesheet: "icons.scss"
+selection_directory: "/vendor/icofont/stylesheets"
+```
+
+- You can either give path for icomoon's generated zip file or you can just give path to the extracted icon set folder.
     
-    $ icomoon [path/to/icomoon.zip file]
+      $ icomoon [path/to/icomoon]
+
 
-> By default this gem assume icomoon assets resides inside our default rails assets folder and this will keep a copy of selection.json file in our applications public folder.
 
 ## Contributing
 

data/exe/icomoon

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 require 'icomoon'
 
-icomoon_zip = ARGV[0]
+icomoon_files = ARGV[0]
 
-abort "Provide a file path to icomoon zip file" unless icomoon_zip
+abort "Provide a file path to icomoon files" unless icomoon_files
 
-Icomoon.update(icomoon_zip)
+Icomoon.import(icomoon_files)

data/icomoon.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Vishal Taj PM"]
   spec.email         = ["vishaltajpm@gmail.com"]
 
-  spec.summary       = %q{Gem is used to update icomoon icons}
-  spec.description   = %q{Gem is used to update icomoon icons in rails application}
+  spec.summary       = "A command line tool to update icomoon icon sets for rails application"
+  spec.description   = "Icomoon gem helps to update icomoon's icons via command line. this gem will automate all the steps to be done while we update icomoon's icon set."
   spec.homepage      = "https://github.com/VishalTaj/icomoon"
   spec.license       = "MIT"
 

data/lib/icomoon.rb

@@ -1,33 +1,47 @@
 require "icomoon/version"
 
+require 'yaml'
+
 module Icomoon
   class Error < StandardError; end
-  def self.update(zipfile)
+  def self.import(icomoon_files)
     begin
-      zipfile = File.join(zipfile)
+      icomoon_files = File.join(icomoon_files)
       app_root = Dir.getwd
-      tmpdir = File.join(app_root, 'tmp', 'iconfont')
-      vendorfontsdir = File.join(app_root, 'app', 'assets', 'fonts')
-      vendorcssdir = File.join(app_root, 'app', 'assets', 'stylesheets')
+      icon_config = YAML.load_file(File.join(app_root, '.icomoon.yml')).to_hash rescue {}
+
+      working_dir = icon_config["working_directory"] ? File.join(app_root, icon_config["working_directory"], "icofont") : File.join(app_root, 'tmp', 'iconfont')
+      working_dir = File.expand_path(working_dir)
+      font_dir = icon_config["font_directory"] ? File.join(app_root, icon_config["font_directory"]) : File.join(app_root, 'app', 'assets', 'fonts')
+      css_dir = icon_config["stylesheet_directory"] ? File.join(app_root, icon_config["stylesheet_directory"]) : File.join(app_root, 'app', 'assets', 'stylesheets')
+      selection_dir = icon_config["selection_directory"] ? File.join(app_root, icon_config["selection_directory"]) : File.join(app_root, 'public', 'selection.json')
+      stylesheet_name = icon_config["stylesheet"] || 'icons.css'
 
-      if !File.exist?(File.join(app_root, 'tmp')) || !File.exist?(vendorfontsdir) || !File.exist?(vendorcssdir)
-        abort "Current directory not a Rails app directory."
+      if (!File.exist?(File.join(app_root, 'tmp')) || !icon_config["working_directory"]) || !File.exist?(font_dir) || !File.exist?(css_dir)
+        abort "Current directory doesn't seems to be an application directory. please move to project root folder and run again"
       end
 
-      unless File.directory? tmpdir
-        system "mkdir #{tmpdir}"
+      unless File.directory? working_dir
+        system "mkdir #{working_dir}"
       end
 
-      system "unzip -u #{zipfile} -d #{tmpdir}"
+      if File.extname(icomoon_files) == '.zip'
+        system "unzip -u #{icomoon_files} -d #{working_dir}"
+        is_temp = true
+      else
+        working_dir = File.expand_path(icomoon_files)
+        is_temp = false
+      end
 
-      Dir.glob(File.join(tmpdir, 'fonts', '*')) do |file|
-        puts "Copying #{file} to #{vendorfontsdir}"
-        system "cp #{file} #{vendorfontsdir}"
+      Dir.glob(File.join(working_dir, 'fonts', '*')) do |file|
+        puts "Copying #{file} to #{font_dir}"
+        system "cp #{file} #{font_dir}"
       end
 
       puts 'Copying the stylesheet'
-      stylesheet = File.join(vendorcssdir, 'icons.scss')
-      system "cp #{File.join(tmpdir, 'style.css')} #{stylesheet}"
+      stylesheet = File.join(css_dir, stylesheet_name)
+      File.write(stylesheet, "") unless File.exist?(stylesheet)
+      system "cp #{File.join(working_dir, 'style.css')} #{stylesheet}"
       
       puts 'Updating font URLs in stylesheet'
       stylesheet_content = File.read(stylesheet)
@@ -37,12 +51,12 @@ module Icomoon
       end
 
       puts 'Updating selection.json file'
-      system "cp -rf #{File.join(tmpdir, 'selection.json')} #{File.join(app_root, 'public', 'selection.json')}"
+      system "cp -f #{File.join(working_dir, 'selection.json')} #{File.join(selection_dir)}"
 
     ensure
-      if File.directory? tmpdir
+      if File.directory?(working_dir) && is_temp
         puts 'Deleting tmp folder'
-        system "rm -rf #{tmpdir}"
+        system "rm -rf #{working_dir}"
       end
     end
   end

data/lib/icomoon/version.rb

@@ -1,3 +1,3 @@
 module Icomoon
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icomoon-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Vishal Taj PM
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-22 00:00:00.000000000 Z
+date: 2019-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Gem is used to update icomoon icons in rails application
+description: Icomoon gem helps to update icomoon's icons via command line. this gem
+  will automate all the steps to be done while we update icomoon's icon set.
 email:
 - vishaltajpm@gmail.com
 executables:
@@ -100,5 +101,5 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: Gem is used to update icomoon icons
+summary: A command line tool to update icomoon icon sets for rails application
 test_files: []