saruman 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+app/*
+*.DS_STORE

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in saruman.gemspec
+gemspec

data/README.md

@@ -0,0 +1,44 @@
+# What is Saruman?
+
+A ruby gem developed by jasonayre of bravenewwebdesign.com (site down currently), to make super complicated, ridiculous, time consuming things in Magento, e.g. creating a new extension, easy.
+
+## NOTE: NOT EVERYTHING HAS BEEN TESTED, USE AT YOUR OWN RISK
+
+### IF YOUR COMPUTER BLOWS UP, NOT MY FAULT. Probably make a new branch before attempting to use, ESPECIALLY if not creating a new extension.
+
+## Installing
+
+    gem install saruman
+    
+Creating a new extension should be working. To do so, navigate to the root directory of your magento installation and call
+
+    saruman extension
+    
+The wizard should take you through the rest of it. I would recommend adding an observer, choose event #3 (checkout_cart_update), and then after it's finished, add an item to your cart and watch the system log, to verify everything is working correctly (well not EVERYTHING, just the observer and general installation of the extension really)
+
+### A picture is worth a thousand words (or is it a million?)
+
+However the phrase goes, its a lot of words, so here is an example of what my terminal looks like after creating a new extension via saruman, along with tailing the magento system log in bottom portion of terminal screen. Oh and I didnt see my itunes open in back when I took screenshot, and too lazy to take a new one, so I would like to state for the record that I have no idea how Katy Perry got into my itunes library, though I suspect it was the work of gremlins, or George W Bush and is part of some 9/11 cover up conspiracy...
+
+![Saruman Image example](/jasonayre/saruman/raw/master/doc_assets/saruman_extension_example.jpg)
+
+### Creating the models
+
+You are able to create an unlimited number of models for your extension, and it is done in rails fashion. E.g, when you get to models part of wizard:
+
+    title:string content:text active:boolean
+
+Will create the magento installer sql using the rails friendly syntax.
+
+### Future stuff
+
+Technically I believe the model command is working, honestly haven't really tested it so I dont recommend using it. The idea behind this whole library is you will be able to do things like
+
+    saruman model
+    
+And then the wizard will let you create any number of models, using a railsish syntax, which will create magento models for a specific extension. It will also create a new version upgrade, along with the resource models and what not.
+
+The coolest part and hardest part to get right, is I'm actually reading the config files of the magento extension, and appending the new data declarations for the models and what not, in an attempt to really simplify the creation of magento extensions. (work in progress, you can try it for now but no promises nothing will break)
+
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/saruman

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'saruman/cli'
+Saruman::CLI.start

data/lib/saruman/cli.rb

@@ -0,0 +1,89 @@
+require 'thor'
+require 'saruman'
+require "highline/import"
+require 'saruman/generators/saruman'
+module Saruman
+  class CLI < Thor
+    
+    desc "extension", "Creates a new magento extension"
+    def extension
+      options = Hash.new
+      
+      options[:namespace] = ask("Enter extension namespace:") { |q| q.default = "Saruman" }
+      options[:name] = ask("Enter extension name:") { |q| q.default = "Wizard" }
+      options[:author] = ask("Author of extension:") { |q| q.default = "Jason Ayre www.bravenewwebdesign.com" }
+      options[:version] = ask("Version number (default - 0.0.1):") { |q| q.default = "0.0.1" }
+      
+      say("Would you like me to create an observer?")
+      choose do |menu|
+        menu.choice(:yes) { options[:observer] = true }
+        menu.choice(:no) { options[:observer] = false }
+      end
+      
+      if(options[:observer])
+        say("Choose the events you would like to observe")
+        begin
+          choose do |menu|
+            if(options[:observer_events]).nil?
+              options[:observer_events] = Array.new
+            end
+            menu.choice(:catalogrule_before_apply) { options[:observer_events].push(:catalog_before_apply) }
+            menu.choice(:catalogrule_after_apply) { options[:observer_events].push(:catalog_after_apply) }
+            menu.choice(:checkout_cart_save_after) { options[:observer_events].push(:checkout_cart_save_after) }
+          end
+        end while agree("Observe another event?")
+        
+      end
+      
+      say("Would you like me to create a model?")
+      choose do |menu|
+        menu.choice(:yes) { options[:model] = true }
+        menu.choice(:no) { options[:model] = false }
+      end
+      
+      if(options[:model])     
+
+          if(options[:models]).nil?
+            options[:models] = Array.new
+          end
+          
+          begin
+            question = Saruman::ModelBuilder.new
+            options[:models] << question.output
+          end while agree("Create another model?")
+        
+      end
+      
+      say("Would you like me to create a helper?")
+      choose do |menu|
+        menu.choice(:yes) { options[:helper] = true }
+        menu.choice(:no) { options[:helper] = false }
+      end
+      
+      Saruman::Generators::Extension.start([options])
+
+    end
+    
+    desc "model", "Creates a new magento model"
+    def model
+      options = Hash.new
+      options[:namespace] = ask("Enter extension namespace:") { |q| q.default = "Saruman" }
+      options[:name] = ask("Enter extension name:") { |q| q.default = "Wizard" }
+      
+        if(options[:models]).nil?
+          options[:models] = Array.new
+        end
+        
+        begin
+          question = Saruman::ModelBuilder.new
+          options[:models] << question.output
+        end while agree("Create another model?")
+
+      
+      Saruman::Generators::Model.start([options])
+      
+    end  
+    
+  end
+  
+end

data/lib/saruman/generators/extension/templates/Helper.php

@@ -0,0 +1,6 @@
+<?php
+
+class <%= combined_namespace %>_Helper_Data extends Mage_Core_Helper_Abstract
+{
+
+}

data/lib/saruman/generators/extension/templates/Model.php

@@ -0,0 +1,11 @@
+<?php
+
+class <%= @model_klass_name %> extends Mage_Core_Model_Abstract
+{
+    public function _construct()
+    {
+        parent::_construct();
+        $this->_init('<%= name_lower %>/<%= @model_name_lower %>');
+    }
+    
+}

data/lib/saruman/generators/extension/templates/Observer.php

@@ -0,0 +1,13 @@
+<?php
+
+class <%= combined_namespace %>_Model_Observer
+{
+  <% observers.each do |event| %>
+  public function <%= event %>($observer)
+  {
+    $event = $observer->getEvent();
+    Mage::log("I put on my robe and wizard hat");
+    Mage::log($event->getEventName().' was called. Winning!');
+  }
+  <% end %>
+}

data/lib/saruman/generators/extension/templates/Resource_Model.php

@@ -0,0 +1,10 @@
+<?php
+
+class <%= @resource_model_klass_name %> extends Mage_Core_Model_Mysql4_Abstract
+{
+  public function _construct()
+  {   
+    $this->_init('<%= name.downcase %>/<%= @model_name.downcase %>', '<%= @table_name %>_id');
+  }
+    
+}    

data/lib/saruman/generators/extension/templates/extension_config.xml

@@ -0,0 +1,81 @@
+<?xml version="1.0"?>
+<!-- 
+/**
+* @category   <%= namespace %>
+* @package    <%= combined_namespace %>
+* @author     <%= author %>
+* @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+*/
+-->
+<config>
+  <modules>
+    <<%= combined_namespace %>>
+      <version>0.0.1</version>
+    </<%= combined_namespace %>>
+  </modules>
+  
+  <frontend>
+    <% if observer? %>
+    <events>
+      <% observers.each do |event| %>
+      <<%= event %>>
+        <observers>
+          <<%= combined_namespace %>_Model_Observer>
+            <type>singleton</type>
+            <class><%= combined_namespace %>_Model_Observer</class>
+            <method><%= event %></method>
+          </<%= combined_namespace %>_Model_Observer>
+        </observers>
+      </<%= event %>>
+      <% end %>
+    </events>
+    <% end %>
+  </frontend>
+ 
+  <global>
+    <% if model? %>
+    <models>
+      <<%= extension_name_lower %>>
+        <class><%= model_klass_name %></class>
+        <resourceModel><%= resource_model_name_lower %></resourceModel>
+      </<%= extension_name_lower %>>
+      <<%= resource_model_name_lower %>>
+        <class><%= resource_model_klass_name %></class>
+        <entities>
+          <% models.each do |model| %>
+          <<%= model[:model_name_lower] %>><table><%= model[:model_table_name] %></table></<%= model[:model_name_lower] %>>
+          <% end %>
+        </entities>
+      </<%= resource_model_name_lower %>>
+    </models>
+    <resources>
+      <<%= extension_name_lower %>_setup>
+        <setup>
+          <module><%= combined_namespace %></module>
+        </setup>
+        <connection>
+          <use>core_setup</use>
+        </connection>
+      </<%= extension_name_lower %>_setup>
+      <<%= extension_name_lower %>_write>
+        <connection>
+          <use>core_write</use>
+        </connection>
+      </<%= extension_name_lower %>_write>
+      <<%= extension_name_lower %>_read>
+        <connection>
+          <use>core_read</use>
+        </connection>
+      </<%= extension_name_lower %>_read>
+    </resources>
+    <% end %>
+    <% if helper? %>
+    <helpers>
+      <<%= name_lower %>>
+        <class><%= combined_namespace %>_Helper</class>
+      </<%= name_lower %>>
+    </helpers>
+    <% end %>    
+  </global>
+  
+</config>

data/lib/saruman/generators/extension/templates/module.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<!-- 
+/**
+ * @category   <%= namespace %>
+ * @package    <%= combined_namespace %>
+ * @author     <%= author %>
+ * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ */
+ -->
+<config>
+  <modules>
+    <<%= namespace %>_<%= name %>>
+      <active>true</active>
+      <codePool>local</codePool>
+    </<%= namespace %>_<%= name %>>
+  </modules>
+</config>

data/lib/saruman/generators/extension/templates/mysql4-install.php

@@ -0,0 +1,19 @@
+<?php
+
+$installer = $this;
+
+$installer->startSetup();
+
+$installer->run("
+<% models.each do |model| %>
+-- DROP TABLE IF EXISTS {$this->getTable('<%= model[:model_table_name] %>')};
+CREATE TABLE {$this->getTable('<%= model[:model_table_name] %>')} (
+  `id` int(11) unsigned NOT NULL auto_increment,
+   <%= model[:sql] %>
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+<% end %>
+
+    ");
+
+$installer->endSetup();

data/lib/saruman/generators/extension.rb

@@ -0,0 +1,167 @@
+# require 'saruman/generators/saruman'
+require 'thor/group'
+
+module Saruman
+  module Generators
+    class Extension < Thor::Group
+      include Thor::Actions
+      argument :arguments, :type => :hash
+      
+      def self.source_root
+        File.dirname(__FILE__) + "/extension/templates"
+      end
+      
+      def copy_global_config
+        template("module.xml", "#{global_config_basepath}#{arguments[:namespace]}_#{arguments[:name]}.xml")
+      end
+      
+      def copy_extension_config
+        template("extension_config.xml", "#{extension_config_path}/config.xml")
+      end
+      
+      def create_model_directory
+        empty_directory(model_path)
+      end
+      
+      def create_observers
+        if observer?
+          template("Observer.php", "#{model_path}Observer.php")
+        end
+      end
+      
+      def create_helper
+        if helper?
+          template("Helper.php", "#{helper_path}Data.php")
+        end  
+      end
+      
+      def create_models
+        if model?
+          
+          models.each do |model|
+            @model_name = model[:model_name]
+            @model_klass_name = "#{namespace}_#{name}_Model_#{@model_name}"
+            @model_name_lower = model[:model_name_lower]
+
+            @resource_model_klass_name = "#{namespace}_#{name}_Model_Mysql4_#{@model_name}"
+            @table_name = model[:model_table_name]
+            template("Model.php", "#{model_path}#{@model_name}.php")
+            template("Resource_Model.php", "#{resource_model_path}#{@model_name}.php")
+          end
+          
+          @setup_path = "#{setup_base_path}#{name_lower}_setup/"
+          empty_directory(@setup_path)
+          template("mysql4-install.php", "#{@setup_path}mysql4-install-#{version}.php")
+        end
+      end
+      
+      private
+      
+      def namespace
+        arguments[:namespace]
+      end
+      
+      def name
+        arguments[:name]
+      end
+      
+      def combined_namespace
+        "#{arguments[:namespace]}_#{arguments[:name]}"
+      end
+      
+      def namespace_lower
+        namespace.downcase
+      end
+      
+      def name_lower
+        name.downcase
+      end
+      
+      #alias for name
+      def extension_name_lower
+        name.downcase
+      end
+      
+      def author
+        arguments[:author]
+      end
+      
+      def version
+        arguments[:version]
+      end  
+      
+      def global_config_basepath
+        "app/etc/modules/"
+      end
+      
+      def extension_base_path
+        "app/code/local/#{namespace}/#{name}/"
+      end
+      
+      def extension_config_path
+        "#{extension_base_path}etc/"
+      end
+      
+      def model_path
+        "#{extension_base_path}Model/"
+      end
+      
+      def resource_model_path
+        "#{model_path}Mysql4/"
+      end  
+      
+      def helper_path
+        "#{extension_base_path}Helper/"
+      end
+      
+      def setup_base_path
+        "#{extension_base_path}/sql/"
+      end
+      
+      def model_klass_name
+        "#{combined_namespace}_Model"
+      end
+      
+      def resource_model_name_lower
+        "#{name_lower}_mysql4"
+      end
+      
+      def resource_model_klass_name
+        "#{combined_namespace}_Model_Mysql4"
+      end  
+      
+      def observer?
+        if arguments[:observer] == true
+          return true
+        else
+          return false
+        end
+      end
+      
+      def observers
+        arguments[:observer_events]
+      end
+      
+      def helper?
+        if arguments[:helper] == true
+          return true
+        else
+          return false
+        end
+      end
+      
+      def model?
+        if arguments[:model] == true
+          return true
+        else
+          return false
+        end
+      end
+      
+      def models
+        arguments[:models]
+      end
+      
+    end
+  end
+end

data/lib/saruman/generators/model/templates/Model.php

@@ -0,0 +1,10 @@
+<?php
+
+class <%= @model_klass_name %> extends Mage_Core_Model_Abstract
+{
+    public function _construct()
+    {
+        parent::_construct();
+        $this->_init('<%= name_lower %>/<%= @model_name_lower %>');
+    }
+}

data/lib/saruman/generators/model/templates/Resource_Model.php

@@ -0,0 +1,10 @@
+<?php
+
+class <%= @resource_model_klass_name %> extends Mage_Core_Model_Mysql4_Abstract
+{
+  public function _construct()
+  {   
+    $this->_init('<%= name.downcase %>/<%= @model_name.downcase %>', 'id');
+  }
+    
+}    

data/lib/saruman/generators/model/templates/model_config_block.xml

@@ -0,0 +1,4 @@
+<<%= extension_name_lower %>>
+  <class><%= model_klass_name %></class>
+  <resourceModel><%= resource_model_name %></resourceModel>
+</<%= extension_name_lower %>>

data/lib/saruman/generators/model/templates/mysql4-install.php

@@ -0,0 +1,19 @@
+<?php
+
+$installer = $this;
+
+$installer->startSetup();
+
+$installer->run("
+<% models.each do |model| %>
+-- DROP TABLE IF EXISTS {$this->getTable('<%= model[:model_table_name] %>')};
+CREATE TABLE {$this->getTable('<%= model[:model_table_name] %>')} (
+  `id` int(11) unsigned NOT NULL auto_increment,
+   <%= model[:sql] %>
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+<% end %>
+
+    ");
+
+$installer->endSetup();

data/lib/saruman/generators/model/templates/resource_model_config_block.xml

@@ -0,0 +1,8 @@
+<<%= resource_model_name %>>
+  <class><%= resource_model_klass_name %></class>
+  <entities>
+    <% models.each do |model| %>
+    <<%= model[:model_name_lower] %>><table><%= model[:model_table_name] %></table></<%= model[:model_name_lower] %>>
+    <% end %>
+  </entities>
+</<%= resource_model_name %>>