shop 0.1.5 → 0.1.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDU4MTExZjE2OWRkZjYzNGEzMTUzYjdlZDQ1MzIxMjMzNzhhMmE4Ng==
+    NWI1Y2YyMzA2ODA5OGQwNWFlYWE4ZWU0MjlkODc1MjZiNTkxZDQ2Mg==
   data.tar.gz: !binary |-
-    MTdlM2M0ZWJiZjg5ZGYyMDVmOGJmYmQ0MDUxZTRjZmZiOTVjZTZlNw==
+    NzgwNWNmYWQwZjJkNDNjZGVkMThhMGZiOGEwMDFlNThkMGFiYWU0ZA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NDQ1MjM2MmE5ZWRmNGZjZTYzNzUxODdhZWVjZDgwMzcxOTk2MGMyNzI5OTQ2
-    NDQ4NzhiY2Y3OWQxMDgxNWU0YTY2ZjQ4ZDMwY2FlYTA2N2EyNDk1ZTVlM2Fk
-    NTJjNWE1MmM0ZjUzMDhmMTIxMTNhZWVlZjA1NDQ3MTMxMmU4MGQ=
+    M2MxY2NhM2RmM2M5ZmVjNTU5ZmI1ZDU0ZWU4MzgwOTdjZjA2OTgzODFiODIx
+    Y2U1NjRlMWRjYmNjOTkxNjVhMmFiNTEzNzY3OThkY2QyMmYxNjM5YWFmMDRl
+    YmQ4YTVmM2RhYzk3ZTdlMjdjMjU1MDFkM2EwODdhYmJiMDhmODc=
   data.tar.gz: !binary |-
-    Y2ViYjIyYWQzMTY0ZDRlZWYyMjgxMjBmM2Q4Yzk3ZTAyNzE0ZTU1Mjg1MzYz
-    ZTAzZWE0MTQ2N2UyYTliY2IyNDIzZDM5ZTJlYWM1OGNkNWMzYWIyNGI5Mjc3
-    YmUzZDhmNGJlYWMyYzdlMGI0MDQ0OGI2YTcwZjIzMzM3NTg4NDQ=
+    OTNlNzg5OGNlZjAwOTI0NGM1MTI1ZThkNzY2ZDQyNTk5MWJiYjgwZmFlNTEz
+    MGIyNGUxOWQ0OTk2ZmU2MGY2ZDg5ZjYxMGQzZDk3MWZjY2NmNzlkNmQ0YzVi
+    YTg0ODcwY2I1ZjIwMjRiMDUxYTFlYjE2ZjZkMTI1MGQwNjMxYzc=

data/Gemfile.lock

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

data/README.md

@@ -64,6 +64,17 @@ Creates overrides files for controllers and classes.
     # generate an override for the Product class
     shop override class Product
 
+### New Pages
+
+You can generate new pages for PrestaShop easily with the `controller` command. This will create the controller, template, CSS and JS files you need to create a new page.
+
+    shop controller <page-name>
+
+    # example:
+    shop controller CustomPage
+
+This task is adapted to work on PrestaShop 1.5 and 1.4.
+
 ### Modules
 
 **The modules related tasks will need the Shop project to be [initialized](https://github.com/romainberger/shop)**
@@ -142,7 +153,12 @@ You can get a list of the available commands with the help:
 
 ## Configuration
 
-You can use a configuration file to automate some values in the templates files created (modules and for the installation of PrestaShop). You can find or create this file in `~/.shop`.
+You can use a configuration file to automate some values in the templates files created (modules and for the installation of PrestaShop).
+You can edit this file with the command
+
+    shop edit
+
+It will open the config file in your `$EDITOR`
 
 ## Compatibility
 

data/lib/shop/color.rb

@@ -0,0 +1,54 @@
+# Shamelessly stolen from https://github.com/holman/boom
+
+module Shop
+  # Color collects some methods for colorizing terminal output.
+  module Color
+    extend self
+
+    CODES = {
+      :reset   => "\e[0m",
+      :cyan    => "\e[36m",
+      :magenta => "\e[35m",
+      :red     => "\e[31m",
+      :yellow  => "\e[33m",
+      :green   => "\e[32m"
+    }
+
+    # Tries to enable Windows support if on that platform.
+    #
+    # Returns nothing.
+    def self.included(other)
+      if RUBY_PLATFORM =~ /win32/ || RUBY_PLATFORM =~ /mingw32/
+        require 'Win32/Console/ANSI'
+      end
+    rescue LoadError
+      # Oh well, we tried.
+    end
+
+    # Wraps the given string in ANSI color codes
+    #
+    # string     - The String to wrap.
+    # color_code - The String representing he ANSI color code
+    #
+    # Examples
+    #
+    #   colorize("Boom!", :magenta)
+    #   # => "\e[35mBoom!\e[0m"
+    #
+    # Returns the wrapped String unless the the platform is windows and
+    # does not have Win32::Console, in which case, returns the String.
+    def colorize(string, color_code)
+      if !defined?(Win32::Console) && !!(RUBY_PLATFORM =~ /win32/ || RUBY_PLATFORM =~ /mingw32/)
+        # looks like this person doesn't have Win32::Console and is on windows
+        # just return the uncolorized string
+        return string
+      end
+      "#{CODES[color_code] || color_code}#{string}#{CODES[:reset]}"
+    end
+
+    # Set up shortcut methods to all the codes define in CODES.
+    self.class_eval(CODES.keys.reject {|color| color == :reset }.map do |color|
+      "def #{color}(string); colorize(string, :#{color}); end"
+    end.join("\n"))
+  end
+end

data/lib/shop/command.rb

@@ -3,6 +3,7 @@
 module Shop
   class Command
     class << self
+      include Shop::Color
 
       def template
         Template.new
@@ -13,11 +14,23 @@ module Shop
         if init?
           return File.read('.shop')
         else
-          puts "Project not initialized. Please run `shop init <theme-name>`"
+          puts "#{red("Error")}: Project not initialized."
+          puts "Please run #{cyan("shop init <theme-name>")}"
           exit
         end
       end
 
+      # Returns the version of Prestashop installed
+      def psVersion
+        if !installed?
+          puts "PrestaShop does not seem to be installed"
+          exit
+        end
+
+        line = File.read("config/settings.inc.php")[/^\s*define\('_PS_VERSION_',\s*.*\)/]
+        line.match(/.*define\('_PS_VERSION_',\s*\s*['"](.*)['"]\)/)[1]
+      end
+
       def execute(*args)
         command = args.shift
         major   = args.shift
@@ -33,15 +46,17 @@ module Shop
         return init(major)                     if command == 'init'
         return install                         if command == 'install'
         return shopModule(major, minor, extra) if command == 'module'
-        return override(major, minor, extra)   if command == 'override'
+        return override(major, major, extra)   if command == 'override'
+        return controller(major)               if command == 'controller'
         return clean(major)                    if command == 'clean'
         return jshint(major)                   if command == 'jshint'
         return makefile                        if command == 'makefile'
+        return edit                            if command == 'edit'
         return version                         if command == "-v"
         return version                         if command == "--version"
         return help                            if command == 'help'
 
-        puts "\nCommand not found"
+        puts "\n#{red("Error")}: Command not found"
         return help
       end
 
@@ -79,12 +94,16 @@ module Shop
         done
       end
 
+      # Returns if the framework is already installed
+      def installed?
+        File.exists?('config/settings.inc.php')
+      end
+
       # Runs the Prestashop install CLI but with a nice prompt
       #
       # See http://doc.prestashop.com/display/PS15/Installing+PrestaShop+using+the+command+line
       def install
-        # check if the framework is already installed
-        if File.exists?('config/settings.inc.php')
+        if installed?
           puts "PrestaShop appears to be already installed"
           exit
         end
@@ -137,7 +156,7 @@ module Shop
       # Init the project
       def init(name)
         if name.nil?
-          puts "Error: Please specify the name of the theme"
+          puts "#{red("Error:")} Please specify the name of the theme"
           return puts "    $ shop init <theme-name>"
         end
 
@@ -170,7 +189,7 @@ module Shop
 
           filepath = "#{path}/#{extra}.tpl"
           if File.exists?(filepath)
-            puts "File already exists"
+            puts "#{red("Error:")} File already exists"
             exit
           else
             File.open(filepath, "w") do; end
@@ -184,7 +203,7 @@ module Shop
           filepath = "#{path}/#{minor}.css"
 
           if File.exists?(filepath)
-            puts "File already exists"
+            puts "#{red("Error:")} File already exists"
             exit
           elsif
             File.open(filepath, "w") do; end
@@ -248,13 +267,79 @@ module Shop
         content = "<?php\n\nclass #{name} extends #{name}Core {\n\n}\n"
 
         if !File.directory?('override')
-          return puts "You need to be at the root of your Prestashop site"
+          return puts "#{red("Error:")} You need to be at the root of your Prestashop site"
         end
 
         File.open(path, 'w') do |f|
           f.write(content)
         end
 
+        clean("class")
+
+        done
+      end
+
+      # Creates a new page with controller and files associated
+      #
+      # @todo adapt this to work with PS 1.4 (needs a .php file in the root dir)
+      def controller(major)
+        if major.nil?
+          puts "#{red("Error")}: Please provide a name for the page"
+          exit
+        end
+        theme
+        version = psVersion
+        version = version[0, 3]
+
+        name = major.downcase
+        controller_name = "#{name.capitalize}Controller"
+        filename = "#{controller_name}.php"
+        if version.to_f >= 1.5
+          controller_path = "controllers/front/#{filename}"
+        elsif version == "1.4"
+          controller_path = "controllers/#{filename}"
+        end
+
+
+        if File.exists?(controller_path)
+          puts "#{red("Error")}: Controller already exists"
+          exit
+        end
+
+        # datas for templates
+        datas = {
+          'controller_name' => controller_name,
+          'name' => name.downcase
+        }
+
+        # 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|
+              f.write(content)
+            end
+            controllerContent = template.template("controller-1.4.php", datas)
+        else
+          controllerContent = template.template("controller.php", datas)
+        end
+
+        File.open(controller_path, "w") do |f|
+          f.write(controllerContent)
+        end
+
+        files = [
+          "themes/#{theme}/#{name}.tpl",
+          "themes/#{theme}/css/#{name}.css",
+          "themes/#{theme}/js/#{name}.js"
+        ]
+
+        files.each do |f|
+          File.open(f, "w") do; end
+        end
+
+        clean("class")
+
         done
       end
 
@@ -269,6 +354,11 @@ module Shop
             File.delete(f)
           end
         elsif major == 'class'
+          version = psVersion
+          if version[0, 3] == "1.4"
+            return
+          end
+
           print "Cleaning class index... "
           index = "cache/class_index.php"
           if File.exists?(index)
@@ -321,7 +411,12 @@ module Shop
       end
 
       def done
-        puts "✔ Done"
+        puts "#{green("✔ Done")}"
+      end
+
+      def edit
+        config = ShopConfig.new
+        puts config.edit
       end
 
       # Returns the version of Shop
@@ -343,6 +438,9 @@ module Shop
             shop module template <name> <hook>     Creates a template for a given module / hook
             shop module css <name>                 Creates an override for a module css
 
+            shop controller <controller-name>      Creates a new page with a controller and
+                                                   assets needed
+
             shop override controller <name>        Creates an override for a controller
             shop override controller <name> admin  Creates an override for an admin controller
             shop override class <name>             Creates an override for a class

data/lib/shop/platform.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+# Partly stolen from https://github.com/holman/boom
+
+module Shop
+  class Platform
+    # Public: tests if currently running on darwin.
+    #
+    # Returns true if running on darwin (MacOS X), else false
+    def darwin?
+      !!(RUBY_PLATFORM =~ /darwin/)
+    end
+
+    # Public: tests if currently running on windows.
+    #
+    # Apparently Windows RUBY_PLATFORM can be 'win32' or 'mingw32'
+    #
+    # Returns true if running on windows (win32/mingw32), else false
+    def windows?
+      !!(RUBY_PLATFORM =~ /mswin|mingw/)
+    end
+
+    # Public: returns the command used to open a file or URL
+    # for the current platform.
+    #
+    # Currently only supports MacOS X and Linux with `xdg-open`.
+    #
+    # Returns a String with the bin
+    def open_command
+      if darwin?
+        'open'
+      elsif windows?
+        'start'
+      else
+        'xdg-open'
+      end
+    end
+  end
+end

data/lib/shop/shopconfig.rb

@@ -33,12 +33,6 @@ module Shop
       get_config
     end
 
-    # Set a value and save the config
-    def set(key, value)
-      config[key] = value
-      save
-    end
-
     def bootstrap
       return if File.exists?(CONFIG_FILE)
       path = template.template_path('shop')
@@ -50,9 +44,27 @@ module Shop
       return @config
     end
 
-    # Save the config in the config file
-    def save
-      # @todo
+    # Public: opens the config file in an editor for you to edit. Uses the
+    # $EDITOR environment variable, or %EDITOR% on Windows for editing.
+    # This method is designed to handle multiple platforms.
+    # If $EDITOR is nil, try to open using the open_command.
+    #
+    # Stolen from https://github.com/holman/boom and adapted
+    #
+    # Returns a String with a helpful message.
+    def edit
+      platform = Platform.new
+      unless $EDITOR.nil?
+        unless platform.windows?
+          system("`echo $EDITOR` #{CONFIG_FILE} &")
+        else
+          system("start %EDITOR% #{CONFIG_FILE}")
+        end
+      else
+        system("#{platform.open_command} #{CONFIG_FILE}")
+      end
+
+      "Make your edits, and do be sure to save."
     end
   end
 end

data/lib/shop.rb

@@ -9,9 +9,11 @@ require 'yaml'
 require 'highline/import'
 
 require 'shop/template'
+require 'shop/color'
 require 'shop/command'
+require 'shop/platform'
 require 'shop/shopconfig'
 
 module Shop
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

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.5'
+  s.version           = '0.1.6'
   s.date              = '2013-09-23'
   s.rubyforge_project = 'shop'
 
@@ -70,8 +70,13 @@ Gem::Specification.new do |s|
     lib/shop/shopconfig.rb
     lib/shop/command.rb
     lib/shop/template.rb
+    lib/shop/color.rb
+    lib/shop/platform.rb
     templates/Makefile
     templates/module.php
+    templates/controller.php
+    templates/controller-1.4.php
+    templates/page.php
     templates/shop
   ]
   # = MANIFEST =

data/templates/controller-1.4.php

@@ -0,0 +1,18 @@
+<?php
+
+class {{controller_name}}Core extends FrontController {
+
+    public function setMedia() {
+        parent::setMedia();
+
+        Tools::addCSS(_THEME_CSS_DIR_.'{{name}}.css');
+        Tools::addJS(_THEME_JS_DIR_.'{{name}}.js');
+    }
+
+    public function displayContent() {
+        parent::displayContent();
+
+        self::$smarty->display(_PS_THEME_DIR_.'{{name}}.tpl');
+    }
+
+}

data/templates/controller.php

@@ -0,0 +1,22 @@
+<?php
+
+class {{controller_name}}Core extends FrontController {
+
+    public function setMedia() {
+        parent::setMedia();
+
+        $this->addCSS(_THEME_CSS_DIR_.'{{name}}.css');
+        $this->addJS(_THEME_JS_DIR_.'{{name}}.js');
+    }
+
+    /**
+     * Assign template vars related to page content
+     * @see FrontController::initContent()
+     */
+    public function initContent() {
+        parent::initContent();
+
+        $this->setTemplate(_PS_THEME_DIR_.'{{name}}.tpl');
+    }
+
+}

data/templates/page.php

@@ -0,0 +1,4 @@
+<?php
+
+require(dirname(__FILE__).'/config/config.inc.php');
+ControllerFactory::getController('{{controller_name}}')->run();

data/templates/shop

@@ -12,3 +12,6 @@ install:
     lastname:
     password:
     email:
+
+template:
+    path:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shop
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Romain Berger
@@ -44,8 +44,13 @@ files:
 - lib/shop/shopconfig.rb
 - lib/shop/command.rb
 - lib/shop/template.rb
+- lib/shop/color.rb
+- lib/shop/platform.rb
 - templates/Makefile
 - templates/module.php
+- templates/controller.php
+- templates/controller-1.4.php
+- templates/page.php
 - templates/shop
 homepage: https://github.com/romainberger/shop
 licenses: