shop 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzFkYzk1N2M1YzI3Nzg5YjU4NmQxOTQ2M2RlMWM5N2Y3MmQ2ZGExNQ==
+    NWI2MTY0N2JhNDllMDVmNGRhMWRjNzRhM2UxNmY0MjFmNDY0MDI0ZQ==
   data.tar.gz: !binary |-
-    YTY3ZTcwNWM2ZmYzNmM2YzA5ZWRjOTQ0ZWQ1ZjI4MjNiOTU0MWE5OA==
+    ZThlZmUzYTQzYTM2NTA3ZGQ3YzYxYzZkNWNjZDRhNzdhOTJiMTc2Zg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MjdlMjRlYjM4MjFhN2QxMGI2NjRkZTliMzdmYjRmMTQwZDk0NzUxNWQ2Yzky
-    N2QzOWQ3NGU3ZDE1OTllM2ZlMTU1MDY0OWZiZjIzOWZhMjgyOGIzYTRmNzQ1
-    NTJjZjEzYTIxZjdmNGU3NTczYzgxZTMzMjI5MzYyYTJjMmQ2Nzc=
+    YjBkNWNkYTY3ZWNkNzM1ZWUyYjM2ZTA5YmY1YjE3MmRjYzUxNzJkYWNiYTYw
+    OTBiMzhmNGI2ZjFhNGIzYTcwNmIxYmNlNTdlMzJiMzE0NzVkMGMwNWExMDNk
+    YjEzOGE3MGM4MDNlZTEyZmRkMTRiNjZhNjcyYmM0OWJhNGVhMzI=
   data.tar.gz: !binary |-
-    Y2YxYjZmNmUxZjgzZTYxMjlhNTgzNTdkZGY3MDYxMmJhNDUwZTFjYjQ4Y2Zh
-    MDI1MzE5ZDMwNjQyYjFjYTc4MzUyMjJlNjA1ZDUxZTE4NWY0N2M1NWQ3MWUz
-    N2Y2YWY4ZjQ0MzAzNGM1ODM1Yjc1Nzk0MmMxMzcxZmFlOWMwNmY=
+    NjQwYjU4YzkyZWQxNDE5NDkyZDU2N2JhMGQzM2Y4NjFjZDM3OWNhOTZiYjM0
+    YWY0MWIwYjJmNTcxNjQ4NzI5ZjliMjQ1YTljMTBjY2I0MTU0NGE0MjI5Mjll
+    YTU0YWYzMmQyMWRkZTA0MzEyZDQ4M2QyYzA0MjY2NzE3ZDUwOGQ=

data/README.md

@@ -1,62 +1,146 @@
 # Shop
 
-CLI for easier Prestashop development. Actually it's just for the lazy people.
+CLI for easier [PrestaShop](http://www.prestashop.com/en/) development. Actually it's just for the lazy people.
 
-## Install
+I always use Rakefiles and Makefiles for lots of tasks. With this gem you can use these tasks without having to create any *akefiles.
 
-    $ gem install shop
+## Installation
+
+    gem install shop
+
+Shop has been developed tested on OSX. I have no idea if this works on other platforms.
 
 ## Usage
 
+### New project
+
+Creates a new Prestashop project with:
+
+    shop new <directory>
+
+    # example:
+    shop new
+    # Download the framework in the current directory
+
+    shop new new-store
+    # Download the framework in a new directory `new-store`
+
+Download the latest stable version of PrestaShop in the current directory or in a subdirectory if you provide the name as argument.
+
+**Note**: Shop can work with an existing PrestaShop project, all you need is to initialize the Shop project (see [Initialization](https://github.com/romainberger/shop/#initialization) below)
+
+### Installation
+
+Since 1.5.4 [PrestaShop provides a CLI](http://doc.prestashop.com/display/PS15/Installing+PrestaShop+using+the+command+line) to install your PrestaShop. You can try to remember every arguments, or just use the Shop task and stay relatively sane (no offense to the PrestaShop developers but... come on).
+
+    # php install/cli.php --name=Romain --lol=whyamitypingallthis
+    # nope
+    shop install
+
+**Note**: the install task actually runs the PrestaShop PHP CLI. It just makes you happier with a nice prompt.
+
 ### Initialization
 
-For some of the task, Shop will need to know the name of the theme you're using. To do that you need to init the project with:
+For some tasks, Shop will need to know the name of the theme you're using. To do that you need to init the project with:
+
+    shop init <theme-name>
 
-    $ shop init <theme-name>
+    # example:
+    shop init my-theme
 
 ### Overrides
 
 Creates overrides files for controllers and classes.
 
-Usage: `$ shop override controller|class Name [admin]
+    shop override <controller|class> <name> [admin]
 
-    $ shop override controller|class Name
-    # Generates an override for a controller or a class
-    # example:
-    $ shop override controller Product
-    # or
-    $ shop override class Product
+    # examples:
+
+    # generate an override for the Product controller
+    shop override controller Product
 
     # by default the controller will be placed in override/controllers/admin. To create an override in
     # override/controllers/admin add the `admin` argument:
-    $ shop override controller AdminProducts
+    shop override controller AdminProducts admin
+
+    # generate an override for the Product class
+    shop override class Product
 
 ### Modules
 
-Create a module or modules' templates files.
+**The modules related tasks will need the Shop project to be [initialized](https://github.com/romainberger/shop)**
+
+Creates a new module (with simple module boilerplate):
+
+    shop module <name>
+
+    # example:
+    shop module dinozaure
+
+Creates a module template:
+
+    shop module template <module-name> <hook-name>
 
-    $ shop module <name>
-    # Generates a boilerplate for a new module
     # example:
-    $ shop module dinozaure
+    shop module template blockcategories blockcategories
+
+Creates a module css file in your theme:
+
+    shop module css <module-name>
 
-    $ shop module template <module-name> <hook-name>
     # example:
-    $ shop module blockcategories blockcategories
+    shop module css blockcategories
 
 ### Cache
 
-    $ shop clean cache
-    # cleans the cache and compile and stuffs
+Cleans the css and js caches.
+
+    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
 
-    $ shop clean class
+    shop clean class
     # clean the class index - automatically done when generating a new controller or class
 
+**Note**: The class index is automatically regenerated when you create an override with Shop. You probably won't need to run this command.
+
+### Jshint
+
+Run jshint on the theme's files.
+
+    shop jshint
+
+To run jshint on the theme's files and the modules' files, run it with the `modules` argument:
+
+    shop jshint modules
+
+To run jshint on **every** files run it with the `hard` argument (prepare yourself for a crapload of errors):
+
+    shop jshint hard
+
+### Makefile
+
+Okay I kinda lied. I still use a Makefile, but only for production servers, as they rarely run gems and I don't necessarily want to install a tool for a limited use (Shop is primarily built for development purpose). But some of these tasks can be usefull on production servers. Shop can generate a Makefile file that will allow you to run some tasks.
+
+**The Makefile task will need the Shop project to be [initialized](https://github.com/romainberger/shop)**
+
+If you already use a Makefile, the tasks will be added to it. If you don't, it will create a Makefile.
+
+    shop makefile
+
+You can then use these tasks. Their effect are similar to the Shop tasks.
+
+    make clean-cache
+
+    make clean-class
+
+
 ### Help
 
 You can get a list of the available commands with the help:
 
-    $ shop help
+    shop help
 
 # Who
 

data/lib/shop/command.rb

@@ -4,30 +4,133 @@ module Shop
   class Command
     class << self
 
+      # Returns the theme name
+      def theme
+        if init?
+          return File.read('.shop')
+        else
+          puts "Project not initialized. Please run `shop init <theme-name>`"
+          exit
+        end
+      end
+
+      # Returns the path to the templates directory
+      def template_path
+        path = File.expand_path File.dirname(__FILE__)
+        "#{path}/../../templates"
+      end
+
       def execute(*args)
         command = args.shift
         major   = args.shift
         minor   = args.shift
-        extra   = args.empty? ? nil : args.join(' ')
+        extra   = args.shift
 
         return help unless command
         dispatch(command, major, minor, extra)
       end
 
       def dispatch(command, major, minor, extra)
+        return newProject(major)               if command == 'new'
         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 clean(major)                    if command == 'clean'
+        return jshint(major)                   if command == 'jshint'
+        return makefile                        if command == 'makefile'
         return version                         if command == "-v"
         return version                         if command == "--version"
         return help                            if command == 'help'
+
+        puts "\nCommand not found"
+        return help
+      end
+
+      # Download the framework in the current dir
+      # or a creates a dir if an argument is given
+      def newProject(path)
+        unless path.nil?
+          FileUtils.mkpath(path)
+        else
+          path = "./"
+        end
+
+        puts "Please wait..."
+        print "Downloading the framework... "
+        url = 'https://github.com/PrestaShop/PrestaShop/archive/master.zip'
+        open("master.zip", "wb") do |f|
+          f << open(url).read
+        end
+        done
+
+        # @todo unzip with a ruby way to avoid platform incompatibilities
+        print "Unzip... "
+        system "unzip -q master.zip"
+        done
+
+        print "Copying... "
+        FileUtils.cp_r(Dir["PrestaShop-master/*"], path)
+        done
+
+        print "Cleaning... "
+        # remove useless files
+        File.delete("master.zip")
+        FileUtils.rm_rf("PrestaShop-master")
+
+        done
+      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')
+          puts "PrestaShop appears to be already installed"
+          exit
+        end
+
+        puts "Please answer the following: "
+
+        entry = Hash.new
+
+        entry[:domain]      = ask('Domain: ')
+        entry[:db_name]     = ask('Database name: ')
+        entry[:db_server]   = ask('Database server: ') { |q| q.default = 'localhost' }
+        entry[:db_user]     = ask('Database user: ') { |q| q.default = 'root' }
+        entry[:db_password] = ask('Database password: ') { |q| q.default = '' }
+        entry[:country]     = ask('Country: ') { |q| q.default = 'fr' }
+        entry[:firstname]   = ask('Firstname: ')
+        entry[:lastname]    = ask('Lastname: ')
+        entry[:password]    = ask('Password: ') { |q| q.default = '0123456789' }
+        entry[:email]       = ask('Email: ')
+        entry[:newsletter]  = 0 # the PS default is to 1, but nobody wants spam
+
+        command = "php install-dev/index_cli.php "
+        command << "--domain=#{entry[:domain]} "
+        command << "--db_name=#{entry[:db_name]} "
+        command << "--db_server=#{entry[:db_server]} "
+        command << "--db_user=#{entry[:db_user]} "
+        command << "--db_password=#{entry[:db_password]} "
+        command << "--country=#{entry[:country]} "
+        command << "--firstname=#{entry[:firstname]} "
+        command << "--lastname=#{entry[:lastname]} "
+        command << "--password=#{entry[:password]} "
+        command << "--email=#{entry[:email]} "
+        command << "--newsletter=#{entry[:newsletter]} "
+
+        # run the php script
+        puts "Installing Prestashop please wait... "
+        system command
+        done
       end
 
       # Init the project
       def init(name)
         if name.nil?
-          return puts "Error: Please specify the name of the theme"
+          puts "Error: Please specify the name of the theme"
+          return puts "    $ shop init <theme-name>"
         end
 
         File.open('.shop', 'w') do |f|
@@ -37,12 +140,46 @@ module Shop
         done
       end
 
+      # Check if the Shop project has been initialized
+      #
+      # Returns a boolean
+      def init?
+        File.exists?('.shop')
+      end
+
       # Creates a module or a module template
       # prefixed with shop for obvious reasons
+      #
+      # The project needs to be initialized
       def shopModule(major, minor, extra)
+        theme
         if major == 'template'
-          # template
-          puts 'create module template'
+          path = "themes/#{theme}/modules"
+          FileUtils.mkpath(path) unless File.directory?(path)
+
+          path = "#{path}/#{minor}"
+          FileUtils.mkpath(path) unless File.directory?(path)
+
+          filepath = "#{path}/#{extra}.tpl"
+          if File.exists?(filepath)
+            puts "File already exists"
+            exit
+          else
+            File.open(filepath, "w") do; end
+          end
+        elsif major == 'css'
+          # css
+          path = "themes/#{theme}/css/modules/#{minor}"
+          FileUtils.mkpath(path) unless File.directory?(path)
+
+          filepath = "#{path}/#{minor}.css"
+
+          if File.exists?(filepath)
+            puts "File already exists"
+            exit
+          elsif
+            File.open(filepath, "w") do; end
+          end
         else
           # create a module
           if File.directory?("modules/#{major}")
@@ -51,7 +188,9 @@ module Shop
             FileUtils.mkpath("modules/#{major}")
             File.open("modules/#{major}/#{major}.php", 'w') do |f|
               name = major.capitalize
-              content = "<?php\n\nclass #{name} extends Module {\n\n}\n"
+              content = File.read("#{template_path}/module.php")
+              content = content.gsub("{{name_capitalize}}", "#{name}")
+              content = content.gsub("{{name}}", "#{major}")
               f.write(content)
             end
           end
@@ -98,24 +237,106 @@ module Shop
       # Clean cache or class index
       def clean(major)
         if major == 'cache'
-          # cache
-          puts 'clean cache'
-        elsif major == 'index'
-          # index
-          puts 'clean index'
+          theme
+          files = Dir["themes/#{theme}/cache/*.css"]
+          files = files + Dir["themes/#{theme}/cache/*.js"]
+
+          files.each do |f|
+            File.delete(f)
+          end
+        elsif major == 'class'
+          print "Cleaning class index... "
+          index = "cache/class_index.php"
+          if File.exists?(index)
+            File.delete(index)
+          end
+          File.open(index, "w") do; end
+          # the file needs to be chmod'ed to 666
+          File.chmod(0666, index)
+        end
+
+        done
+      end
+
+
+      # Run jshint
+      def jshint(major)
+        theme
+        files = Dir["themes/#{theme}/js/**/*.js"]
+
+        if major == 'modules' || major == 'hard'
+          modules = Dir["modules/**/*.js"]
+          files = files + modules
+        end
+        if major == 'hard'
+          prestashop = Dir["js/**/*.js"]
+          files = files + prestashop
+        end
+
+        files.each do |f|
+          system "jshint #{f}"
         end
       end
 
+      # Create a Makefile or add some tasks to an existing one
+      def makefile
+        theme
+        content = File.read("#{template_path}/Makefile")
+        content = content.gsub("{{theme}}", "#{theme}")
+        if File.exists?("Makefile")
+          File.open("Makefile", "a") do |f|
+            f.write(content)
+          end
+        else
+          File.open("Makefile", "w") do |f|
+            f.write(content)
+          end
+        end
+
+        done
+      end
+
       def done
         puts "✔ Done"
       end
 
+      # Returns the version of Shop
       def version
         puts "Shop #{Shop::VERSION}"
       end
 
+      # Prints all the command available
       def help
-        puts "Output help"
+        text = %{
+          Shop v.#{Shop::VERSION} -------------------------------
+
+            shop new <directory>                   Download the framework
+            shop install                           Install Prestashop
+
+            shop init                              Creates a Shop config file
+
+            shop module <name>                     Creates a new module
+            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 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
+
+            shop clean cache                       Cleans the css and js caches
+            shop clean class                       Cleans the class index
+
+            shop jshint                            Run jshint on the theme files
+            shop jshint modules                    Run jshint on the theme and modules files
+            shop jshint hard                       Run jshint on every files
+
+            shop makefile                          Creates a Makefile or add tasks to an existing one
+
+          See the complete documentation at:
+          https://github.com/romainberger/shop
+
+        }.gsub(/^ {10}/, '')
+        puts text
       end
     end
   end

data/lib/shop.rb

@@ -3,10 +3,10 @@
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
 require 'fileutils'
+require 'open-uri'
 
 require 'shop/command'
-require 'shop/color'
 
 module Shop
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/shop.gemspec

@@ -13,13 +13,13 @@ 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.0'
+  s.version           = '0.1.1'
   s.date              = '2013-03-12'
   s.rubyforge_project = 'shop'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.
-  s.summary     = "Command line interface for easy Prestashop development"
+  s.summary     = "CLI for easy Prestashop development"
   s.description = "Because I'm too lazy to create files and type code"
 
   ## List the primary authors. If there are a bunch of authors, it's probably
@@ -49,6 +49,7 @@ Gem::Specification.new do |s|
 
   ## List your runtime dependencies here. Runtime dependencies are those
   ## that are needed for an end user to actually USE your code.
+  s.add_dependency('highline', "~> 1.6.19")
 
   ## List your development dependencies here. Development dependencies are
   ## those that are only needed during development
@@ -62,7 +63,8 @@ Gem::Specification.new do |s|
     shop.gemspec
     lib/shop.rb
     lib/shop/command.rb
-    lib/shop/color.rb
+    templates/Makefile
+    templates/module.php
   ]
   # = MANIFEST =
 

data/templates/Makefile

@@ -0,0 +1,14 @@
+CHECK=✔ Done
+HR=--------------------------------------------------
+
+clean-class:
+	@sudo printf "Cleaning class index..."
+	@rm cache/class_index.php
+	@touch cache/class_index.php
+	@chmod 666 cache/class_index.php
+	@echo "                   ${CHECK}"
+
+clean-cache:
+	@printf "Cleaning cache..."
+	-@rm themes/{{theme}}/cache/*.css themes/{{theme}}/cache/*.js 2>/dev/null || true
+	@echo "                   ${CHECK}"

data/templates/module.php

@@ -0,0 +1,22 @@
+<?php
+
+class {{name_capitalize}} extends Module {
+
+    public function __construct() {
+        $this->name = '{{name}}';
+        $this->tab = '';
+        $this->version = 0.1;
+        $this->author = '';
+
+        parent::__construct();
+
+        $this->displayName = $this->l('');
+        $this->description = $this->l('');
+
+    }
+
+    public function install() {
+        parent::install();
+    }
+
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Romain Berger
@@ -9,7 +9,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2013-03-12 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.19
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.19
 description: Because I'm too lazy to create files and type code
 email: romain@romainberger.com
 executables:
@@ -23,7 +37,8 @@ files:
 - shop.gemspec
 - lib/shop.rb
 - lib/shop/command.rb
-- lib/shop/color.rb
+- templates/Makefile
+- templates/module.php
 - README.md
 - LICENSE.md
 homepage: https://github.com/romainberger/shop
@@ -50,5 +65,5 @@ rubyforge_project: shop
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 2
-summary: Command line interface for easy Prestashop development
+summary: CLI for easy Prestashop development
 test_files: []

data/lib/shop/color.rb

@@ -1,54 +0,0 @@
-# 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"
-    }
-
-    # 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