shop 0.1.7 → 0.1.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDU3ZjdhODg4OWQzNDZlZjhmNzg3NDIwODdhMTVjYWVkOWI0ZmNiMg==
+    OTUxZjYwODM5NjMwNGY2OGJhMzZiNTFlMTI1YzRmYjQ1ZTc5N2QwZQ==
   data.tar.gz: !binary |-
-    Mjk0ZmU4ZDU1ODZlZWNiMGNhMWRlMTU1ZTcyYjZjMzlkOThhZjE0OA==
+    YmRjNjJmNzU0YWI5NzA3ODk2MTlkMWQ2NzI0NWYwNTRkYmExYWJhYg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDVkMmU5YzY3N2ZkYjJjYzEyOGFlNWViZmJlODlmMDljOTEzZTQ5ZTBhNmVk
-    YjFiNWNmOGQyNTRkNTFmM2FkNmY3Yjg3ZjA0Nzk4MGY2MzQ5MjEyMDc0ZGM5
-    NDg2ZmY0YzY1Mjk5YTNhMWI2YzVmMTgzNGIwMzE3NzBkMDE5MjU=
+    OWE3ZTIxYjIxNzZmZmFlZjg2Y2E4NzgyMmQxOTdhZmEwNTFmNzYzYTc4ZjFk
+    NmQ3MThkOGE4MTNlZjg0ZDU2NmJhNDE0YTQ0YTNkODQwMzVmNDkwYWEzOWM0
+    MmYxNzk2NTg2NDUzOWY3M2U0ZDBmOThkZDZjZDQxZDkyN2RhNGE=
   data.tar.gz: !binary |-
-    YzljZWU1NGIyZmI4ZDkzYzA1ODkwYTY4MTNlMWNhYjgyMTA1YzJlZmQyYzM5
-    YzgwNDA0ZDBjODQ0ODhhZDI0YjZhMDkwOGY4NDQ5MWJkNDFjNWUzZmQ4ODhm
-    ODJhY2RmMTRjODcyYjhjMzY1NDZkYWMyYmM0OGZhOTI1ZTk0OTg=
+    ZDFhMzVhMjEzMTRjMDVmZWVmNWRlNzlmOWNkOGNhZTNiMDc1ZmI0OTNhY2U4
+    NDUwZGZlNTVlMDc1ZGE3MTgyZTc3NjgzYjY3MjBjYWU0ZDJhYjVmMThlMjEx
+    YWQ2MmZjM2YxMjkxY2Y0MjkzODM3NDFmNDI5MGMyZmVlMmE4ZWM=

data/Changelog.md

@@ -1,7 +1,12 @@
 # Shop changelog
 ## Head
 
-## Head
+## 0.1.8
+- By default the clean task clean the cache
+- Add a `template` section to the configuration file so you can use custom templates
+- Output the files created for every tasks
+- Allow the use of the `module` task with or without file extension. ie. `shop module template name template` or `shop module template name template.tpl`
+- Fix controller task and keep camelcased controllers name
 
 ## 0.1.6
 - Add an `edit` command to edit the config file

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shop (0.1.7)
+    shop (0.1.8)
       highline (~> 1.6.19)
 
 GEM

data/README.md

@@ -2,7 +2,7 @@
 
 CLI for easier [PrestaShop](http://www.prestashop.com/en/) development. Actually it's just for the lazy people.
 
-I always use Rakefiles and Makefiles for lots of tasks. With this gem you can use these tasks without having to create any *akefiles.
+I always use Rakefiles and Makefiles for lots of tasks. With this gem you can use these tasks without having to create any *akefiles. For more infos about how and why see: [Introducing Shop](http://romainberger.com/2013/09/29/introducing-shop/).
 
 ## Installation
 
@@ -104,7 +104,7 @@ Creates a module css file in your theme:
 
 Cleans the css and js caches.
 
-    shop clean cache
+    shop clean [cache]
     # cleans the css and js caches
 
 When you create a new override for a controller or a class, the class index needs to be rewritten. You can call this task
@@ -112,6 +112,8 @@ When you create a new override for a controller or a class, the class index need
     shop clean class
     # clean the class index - automatically done when generating a new controller or class
 
+By default the `clean` task will clean the cache so you can just use `shop clean`.
+
 **Note**: The class index is automatically regenerated when you create an override with Shop. You probably won't need to run this command.
 
 ### Jshint
@@ -158,14 +160,15 @@ You can edit this file with the command
 
     shop edit
 
-It will open the config file in your `$EDITOR`
+It will open the config file in your `$EDITOR`. It's YAML so it shouldn't be scary.
 
 ## Compatibility
 
-Shop has been developed and tested on osx. It may not work on platforms other than *nix, particularly the `new` command that uses the unix `unzip` command. I plan on working on rewriting this part with only Ruby so it could work everywhere.
+Shop has been developed and tested on osx. It may not work on platforms other than *nix, particularly the `new` command that uses the unix `unzip` command. I plan on working on rewriting this part with only Ruby so it could work everywhere. I'm not going to try it on Windows so feel free to open issues (or even better, contribute) if you notice something not working as expected.
 
 ## Who
 
 By [Romain Berger](http://romainberger.com).
 Ping me at [@romain__berger](http://twitter.com/romain__berger) if you're having issues or create an issue.
+
 If you become billionaire with a shop made with the help of Shop you must buy me a beer.

data/lib/shop.rb

@@ -15,5 +15,5 @@ require 'shop/platform'
 require 'shop/shopconfig'
 
 module Shop
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end

data/lib/shop/command.rb

@@ -160,6 +160,7 @@ module Shop
           return puts "    $ shop init <theme-name>"
         end
 
+        puts "      #{green("create")} .shop"
         File.open('.shop', 'w') do |f|
           f.write(name)
         end
@@ -187,11 +188,13 @@ module Shop
           path = "#{path}/#{minor}"
           FileUtils.mkpath(path) unless File.directory?(path)
 
-          filepath = "#{path}/#{extra}.tpl"
+          filepath = "#{path}/#{extra}"
+          filepath = "#{filepath}.tpl" unless filepath.match(/\.tpl$/)
           if File.exists?(filepath)
             puts "#{red("Error:")} File already exists"
             exit
           else
+            puts "      #{green("create")} #{filepath}"
             File.open(filepath, "w") do; end
           end
         elsif major == 'css'
@@ -200,12 +203,14 @@ module Shop
           path = "themes/#{theme}/css/modules/#{minor}"
           FileUtils.mkpath(path) unless File.directory?(path)
 
-          filepath = "#{path}/#{minor}.css"
+          filepath = "#{path}/#{minor}"
+          filepath = "#{filepath}.css" unless filepath.match(/\.css$/)
 
           if File.exists?(filepath)
             puts "#{red("Error:")} File already exists"
             exit
           elsif
+            puts "      #{green("create")} #{filepath}"
             File.open(filepath, "w") do; end
           end
         else
@@ -213,6 +218,7 @@ module Shop
           if File.directory?("modules/#{major}")
             return puts "Module #{major} already exists"
           else
+            puts "      #{green("create")} modules/#{major}"
             FileUtils.mkpath("modules/#{major}")
             config = ShopConfig.new
             values = {
@@ -222,6 +228,7 @@ module Shop
               "tab" => config.get('module', 'tab')
             }
             content = template.template("module.php", values)
+            puts "      #{green("create")} modules/#{major}/#{major}.php"
             File.open("modules/#{major}/#{major}.php", 'w') do |f|
               f.write(content)
             end
@@ -230,9 +237,11 @@ module Shop
             logo = config.get('module', 'logo')
             if logo.length != 0
               if File.exists?("#{logo}.png")
+                puts "      #{green("create")} modules/#{major}/logo.png"
                 FileUtils.cp("#{logo}.png", "modules/#{major}/logo.png")
               end
               if File.exists?("#{logo}.gif")
+                puts "      #{green("create")} modules/#{major}/logo.gif"
                 FileUtils.cp("#{logo}.gif", "modules/#{major}/logo.gif")
               end
             end
@@ -270,6 +279,7 @@ module Shop
           return puts "#{red("Error:")} You need to be at the root of your Prestashop site"
         end
 
+        puts "      #{green("create")} #{path}"
         File.open(path, 'w') do |f|
           f.write(content)
         end
@@ -291,8 +301,11 @@ module Shop
         version = psVersion
         version = version[0, 3]
 
-        name = major.downcase
-        controller_name = "#{name.capitalize}Controller"
+        # convert the name to camelcase to hyphen
+        name = major.split(/(?=[A-Z])/)
+        name = name.join('-').downcase
+
+        controller_name = "#{major}Controller"
         filename = "#{controller_name}.php"
         if version.to_f >= 1.5
           controller_path = "controllers/front/#{filename}"
@@ -300,7 +313,6 @@ module Shop
           controller_path = "controllers/#{filename}"
         end
 
-
         if File.exists?(controller_path)
           puts "#{red("Error")}: Controller already exists"
           exit
@@ -309,14 +321,15 @@ module Shop
         # datas for templates
         datas = {
           'controller_name' => controller_name,
-          'name' => name.downcase
+          'name' => name
         }
 
         # For PS 1.4 creates a php file a the root
         # and use the appropriate template
         if version[0, 3] == "1.4"
             content = template.template("page.php", datas)
-            File.open("#{name.downcase}.php", "w") do |f|
+            puts "      #{green("create")} #{name}.php"
+            File.open("#{name}.php", "w") do |f|
               f.write(content)
             end
             controllerContent = template.template("controller-1.4.php", datas)
@@ -324,6 +337,7 @@ module Shop
           controllerContent = template.template("controller.php", datas)
         end
 
+        puts "      #{green("create")} #{controller_path}"
         File.open(controller_path, "w") do |f|
           f.write(controllerContent)
         end
@@ -335,6 +349,7 @@ module Shop
         ]
 
         files.each do |f|
+          puts "      #{green("create")} #{f}"
           File.open(f, "w") do; end
         end
 
@@ -345,7 +360,7 @@ module Shop
 
       # Clean cache or class index
       def clean(major)
-        if major == 'cache'
+        if major.nil? || major == 'cache'
           theme
           files = Dir["themes/#{theme}/cache/*.css"]
           files = files + Dir["themes/#{theme}/cache/*.js"]
@@ -359,7 +374,7 @@ module Shop
             return
           end
 
-          print "Cleaning class index... "
+          print "      Cleaning class index... "
           index = "cache/class_index.php"
           if File.exists?(index)
             File.delete(index)
@@ -403,6 +418,7 @@ module Shop
           end
         else
           File.open("Makefile", "w") do |f|
+            puts "      #{green("create")} Makefile"
             f.write(content)
           end
         end
@@ -411,7 +427,7 @@ module Shop
       end
 
       def done
-        puts "#{green("✔ Done")}"
+        puts "\n      #{green("✔ Done")}"
       end
 
       def edit
@@ -445,7 +461,7 @@ module Shop
             shop override controller <name> admin  Creates an override for an admin controller
             shop override class <name>             Creates an override for a class
 
-            shop clean cache                       Cleans the css and js caches
+            shop clean [cache]                     Cleans the css and js caches
             shop clean class                       Cleans the class index
 
             shop jshint                            Run jshint on the theme files
@@ -454,6 +470,10 @@ module Shop
 
             shop makefile                          Creates a Makefile or add tasks to an existing one
 
+            shop edit                              Open the configuration file in your $EDITOR
+            shop help                              Output this help text
+            shop version                           Output the version of Shop you are using
+
           See the complete documentation at:
           https://github.com/romainberger/shop
 

data/lib/shop/template.rb

@@ -2,15 +2,31 @@
 module Shop
   class Template
 
+    # Returns the path to the custom template if it exists
+    def custom_template_path(name)
+      config = ShopConfig.new
+      custom_path = config.get('template', 'path')
+      if File.exists?("#{custom_path}/#{name}")
+        "#{custom_path}/#{name}"
+      else
+        false
+      end
+    end
+
     # Returns the path to the templates directory
     #
     # Returns string
     def template_path(name=false)
-      path = File.expand_path File.dirname(__FILE__)
+      custom_path = custom_template_path(name)
+      if custom_path
+        custom_path
+      else
+        path = File.expand_path File.dirname(__FILE__)
 
-      return "#{path}/../../templates/#{name}" if name
+        return "#{path}/../../templates/#{name}" if name
 
-      "#{path}/../../templates"
+        "#{path}/../../templates"
+      end
     end
 
     # Replace the placeholders by the variables
@@ -20,7 +36,7 @@ module Shop
     #
     # Returns string
     def template(name, datas)
-      file = "#{template_path}/#{name}"
+      file = template_path(name)
       content = File.read(file)
 
       datas.each do |k, v|

data/shop.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'shop'
-  s.version           = '0.1.7'
+  s.version           = '0.1.8'
   s.date              = '2013-09-29'
   s.rubyforge_project = 'shop'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shop
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Romain Berger