occs-wizard 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbcdbfa280709b1b67cdc1df1bb8110482b725c3
+  data.tar.gz: 577a04bd82376a34cd380b2085258a518ce6f2ae
+SHA512:
+  metadata.gz: 82f456987e274222001cac6d3c546a12133b33aba1e80f69d0d7a4adede0a783497d2483d1e434d4e5e88ef4d8262af7a3c55b1f4c795ffec9ca6c42ab61bae0
+  data.tar.gz: 678d3e44b0189417f122fc701b7a82bc71b967be82de4362621be9f6031df1fd3a586364d0b06fc354748b5cb64b8ed818a68967c1b8b4f104b5a03b7b8c41e4

data/lib/occs-wizard.rb

@@ -0,0 +1,254 @@
+require 'fileutils'
+require 'json'
+
+class Wizard
+
+  attr_accessor :extension_id, :developer_id, :created_by, :created_at, :extension_name, :description
+  VERSION = 1
+
+  def set_extension_id(ext)
+    raise ArgumentError, 'Argument is not a valid OCCS extension id, please read the documentation for further details' unless ext.size == 36 && ext.is_a?(String)
+    self.extension_id = ext
+  end
+
+  def get_extension_id
+    self.extension_id
+  end
+
+  def set_developer_id(dev_id)
+    raise ArgumentError, 'Developer ID value is not valid, please read the documentation for further details' unless dev_id.size >= 8
+    self.developer_id = dev_id
+  end
+
+  def get_developer_id
+    self.developer_id
+  end
+
+  def set_created_at
+    time = Time.now
+    current = time.to_s.scan(/\w+/)
+    today = "#{current[0]}-#{current[1]}-#{current[2]}"
+    self.created_at = today
+  end
+
+  def get_created_at
+    self.created_at
+  end
+
+  def set_created_by(name = "OCCS Wizard Developer")
+    self.created_by = name
+  end
+
+  def get_created_by
+    self.created_by
+  end
+
+  def set_extension_name(ext_name)
+    raise ArgumentError, 'Extension name cannot be empty' unless ext_name.size > 0
+    self.extension_name = ext_name
+  end
+
+  def get_extension_name
+    ext_name = self.extension_name.delete(' ').downcase
+  end
+
+  def set_description(desc)
+    raise ArgumentError, 'Extension description cannot be empty' unless desc.size > 0
+    self.description = desc
+  end
+
+  def get_description
+    self.description
+  end
+
+  # crate the ext.json file
+  def create_ext_json_file(directory)
+    ext_json = {
+        extensionID: self.get_extension_id,
+        developerID: self.get_developer_id,
+        createdBy: self.created_by,
+        name: self.get_extension_name,
+        version: VERSION,
+        timeCreated: self.get_created_at,
+        description: self.get_description
+    }
+    # write the file
+    File.open(directory,"w") do |f|
+      # call the convert_to_json private method and write a json file
+      f.write(convert_to_json(ext_json))
+    end
+  end
+
+  # create the file widget.json
+  def create_widget_json_file(directory)
+    widget_json = {
+        name: self.get_extension_name,
+        version: VERSION,
+        global: false,
+        javascript: "widget-#{self.get_extension_name}-js",
+        pageTypes: ["home"],
+        imports: ["products"],
+        jsEditable: true,
+        config: {}
+    }
+
+    # write the file
+    File.open(directory,"w") do |f|
+      # call the convert_to_json private method and write a json file
+      f.write(convert_to_json(widget_json))
+    end
+  end
+
+  # create the display.template file
+  def create_display_template_file(directory)
+    html = %{<!-- Template File -->\n
+<div class="myWidget">Hello World</div>}
+
+    File.open(directory, "w") do |f|
+      f.write(html)
+    end
+  end
+
+  # create the less file
+  def create_less_file(directory)
+    less = %{/* Widget CSS Less */\n
+.myWidget {}}
+
+    File.open(directory, "w") do |f|
+      f.write(less)
+    end
+  end
+
+  # create the javascript file
+  def create_js_file(directory)
+    js = %{// Javascript widget file\n
+    define(\n
+      // Dependencies\n
+      ['jquery', 'knockout'],\n
+      // Module Implementation\n
+      function($, ko) {\n
+         // We recommend enabling strict checking mode\n
+         'use strict';\n
+         // Private variables and functions can be defined here...\n
+         var SOME_CONSTANT = 1024;\n
+         var privateMethod = function () {\n
+           // ...\n
+         };\n
+         return {\n
+          // Widget JS\n
+          onLoad: function(widget) {},\n
+          // Some member variables...\n
+          // Some public methods...\n
+        }\n
+    });}
+
+    File.open(directory, "w") do |f|
+      f.write(js)
+    end
+  end
+
+  # Project Structure
+  def create_project_structure
+    # create the project date
+    self.set_created_at
+    # go back one dir
+    Dir.chdir('..')
+    raise Exception, "Folder #{self.extension_name} already exists" unless !File.directory?("#{self.extension_name}")
+    # make a new root dir with the extension name
+    FileUtils.mkdir(self.extension_name)
+    # enter inside the new root dirt
+    Dir.chdir("#{self.extension_name}")
+    # create the widget folder
+    FileUtils.mkdir('widget')
+    # create the file ext.json
+    self.create_ext_json_file("ext.json")
+    # enter inside widget folder
+    Dir.chdir('./widget')
+    # create the extension name folder with no spaces and lowered
+    FileUtils.mkdir(self.get_extension_name)
+    # enter inside the extensionname folder
+    Dir.chdir("./#{self.get_extension_name }")
+    # make the template folder
+    FileUtils.mkdir("templates")
+    # make the js folder
+    FileUtils.mkdir("js")
+    # make the less folder
+    FileUtils.mkdir("less")
+    # write the widget.json file
+    self.create_widget_json_file("widget.json")
+    # move into the templates folder
+    Dir.chdir("./templates")
+    # write the display.template file
+    self.create_display_template_file("display.template")
+    # move back one dir
+    Dir.chdir("..")
+    # move inside the less folder
+    Dir.chdir("./less")
+    # write the less file
+    self.create_less_file("widget.less")
+    # move back one dir
+    Dir.chdir("..")
+    # move inside the js folder
+    Dir.chdir("./js")
+    # write the js file
+    self.create_js_file("widget-#{self.get_extension_name}-js.js")
+    # move back one dir
+    Dir.chdir("..")
+    # create the config folder
+    Dir.mkdir("config")
+
+  end
+
+  def get_user_input
+    puts "\n"
+    puts ".:: OCCS Widget Wizard ::."
+    puts "\n"
+    puts "Please have a look at the Oracle Commerce Cloud official documentation for more info"
+    puts "https://goo.gl/i5d6us"
+    puts "\n"
+    print "Please enter the extension id: "
+    dev_id = gets.chomp
+    self.set_extension_id(dev_id)
+    puts "\n"
+    print "Please enter your developer id: "
+    dev_id = gets.chomp
+    self.set_developer_id(dev_id)
+    puts "\n"
+    print "Enter the developer name: "
+    dev_name = gets.chomp
+    self.set_created_by(dev_name)
+    puts "\n"
+    print "Enter the extension name: "
+    ext_name = gets.chomp
+    self.set_extension_name(ext_name)
+    puts "\n"
+    print "Enter the extension description: "
+    ext_desc = gets.chomp
+    self.set_description(ext_desc)
+    puts "\n"
+
+    begin
+      self.create_project_structure
+      puts "\n"
+      puts "Project '#{self.extension_name}' was successfully created at #{Dir.pwd}"
+      puts "\n"
+    rescue
+      puts "Sorry but there was an error creating your widget structure, please try again"
+    end
+
+  end
+
+  def initialize
+    self.get_user_input
+  end
+
+  private
+  def convert_to_json(string)
+    json = string.to_json
+    json_formatted = JSON.parse(json)
+    JSON.pretty_generate(json_formatted)
+  end
+
+end
+
+w = Wizard.new

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: occs-wizard
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Valerio D'Alessio - @valdal14
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-31 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: valdal14@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/occs-wizard.rb
+homepage: https://twitter.com/valdal14
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: A wizard to create Oracle Commerce Cloud basic widget structure
+test_files: []