pgxn_utils 0.0.4 → 0.1.1

data/README.md

@@ -1,10 +1,10 @@
 pgxn utils
 ==========
 
-What is?
+What is it?
 --------
 
-This is a set of task that aims to help PostgreSQL developers to focus more on the problem that they wants to solve than in the all structure and files and control files need to PGXS to build the extension.
+It aims to be a set of task that aims to help PostgreSQL extension's developers to focus more on the problem that they wants to solve than in the all structure and files and control files need to PGXS to build the extension.
 
 It's a WIP but very functional. Please use it and help me improve it.
 
@@ -16,31 +16,17 @@ How to install it?
 How it works?
 -------------
 
-    $ pgxn_utils help skeleton
-    Usage:
-      pgxn_utils skeleton extension_name
+It is all about tasks. Let's see what tasks we have:
 
-    Options:
-      -p, [--target=TARGET]                    # Define the target directory
-                                               # Default: .
-      -m, [--maintainer=MAINTAINER]            # Maintainer's name
-                                               # Default: The maintainer's name
-      -e, [--maintainer-mail=MAINTAINER_MAIL]  # Maintainer's mail
-                                               # Default: maintainer@email.here
-      -a, [--abstract=ABSTRACT]                # Defines a short description to abstract
-                                               # Default: A short description
-      -l, [--license=LICENSE]                  # The extension license.
-                                               # Default: postgresql
-      -v, [--version=VERSION]                  # Initial version
-                                               # Default: 0.0.1
-      -d, [--description=DESCRIPTION]          # A long text that contains more information about extension
-                                               # Default: A long description
-      -b, [--generated-by=GENERATED_BY]        # Name of extension's generator
-      -t, [--tags=one two three]               # Defines extension's tags
-      -r, [--release-status=RELEASE_STATUS]    # Initial extension's release status
-                                               # Default: unstable
-
-See in action...
+    $ pgxn_utils help
+    Tasks:
+      pgxn_utils bundle [extension_name]  # Bundles an extension
+      pgxn_utils change [extension_name]  # Change META's attributes in current extension
+      pgxn_utils help [TASK]              # Describe available tasks or one specific task
+      pgxn_utils skeleton extension_name  # Creates an extension skeleton in current directory
+
+
+# Creating a new extension
 
     $ pgxn_utils skeleton my_cool_extension
           create  my_cool_extension
@@ -54,7 +40,83 @@ See in action...
           create  my_cool_extension/test/expected/base.out
           create  my_cool_extension/test/sql/base.sql
 
-Thats it! Start coding! ":)
+Thats it! Just start coding! ":)
+
+# Changing something
+
+Well suppose you want to change the default maintainer's name and the license, well just do:
+
+    $ pgxn_utils change my_cool_extension --maintainer "Dickson Guedes" --license bsd
+           exist  my_cool_extension
+       identical  my_cool_extension/my_cool_extension.control
+        conflict  my_cool_extension/META.json
+    Overwrite /home/guedes/extensions/my_cool_extension/META.json? (enter "h" for help) [Ynaqdh] d
+      {
+         "name": "my_cool_extension",
+         "abstract": "A short description",
+         "description": "A long description",
+         "version": "0.0.1",
+    -    "maintainer": "The maintainer's name",
+    +    "maintainer": "Dickson Guedes",
+    -    "license": "postgresql",
+    +    "license": "bsd",
+         "provides": {
+            "my_cool_extension": {
+               "abstract": "A short description",
+               "file": "sql/my_cool_extension.sql",
+               "docfile": "doc/my_cool_extension.md",
+               "version": "0.0.1"
+            }
+         },
+         "release_status": "unstable",
+      
+         "generated_by": "The maintainer's name",
+      
+      
+         "meta-spec": {
+            "version": "1.0.0",
+            "url": "http://pgxn.org/meta/spec.txt"
+         }
+      }
+    Retrying...
+    Overwrite /home/guedes/extensions/my_cool_extension/META.json? (enter "h" for help) [Ynaqdh]
+           force  my_cool_extension/META.json
+       identical  my_cool_extension/Makefile
+    ...
+    ...
+    ...
+
+It will wait you decide what to do.
+
+For all switches that you can use with *change*, type:
+
+    $ pgxn_utils help change
+    Usage:
+      pgxn_utils change [extension_name]
+
+    Options:
+      -m, [--maintainer=MAINTAINER]          # Maintainer's name <maintainer@email>
+      -a, [--abstract=ABSTRACT]              # Defines a short description to abstract
+      -l, [--license=LICENSE]                # The extension license.
+      -v, [--version=VERSION]                # Initial version
+      -d, [--description=DESCRIPTION]        # A long text that contains more information about extension
+      -b, [--generated-by=GENERATED_BY]      # Name of extension's generator
+      -t, [--tags=one two three]             # Defines extension's tags
+      -r, [--release-status=RELEASE_STATUS]  # Initial extension's release status
+
+
+# Bundle it!
+
+Well, since you finished your work you can bundle it to send to [PGXN](http://pgxn.org).
+
+Just type:
+
+    $ pgxn_utils bundle my_cool_extension
+    Extension generated at: /home/guedes/extensions/my_cool_extension-0.0.1.zip
+
+# Working in progress
+
+I'm working in an option to release the bundled extension, sending it to [PGXN](http://pgxn.org).
 
 Copyright and License
 ---------------------

data/bin/pgxn_utils

@@ -2,4 +2,8 @@
 $:.unshift File.expand_path('..', __FILE__)
 $:.unshift File.expand_path('../../lib', __FILE__)
 require 'pgxn_utils'
-PgxnUtils::CLI.start
+
+task = __FILE__.split('-')[1] if File.basename(__FILE__) != 'pgxn_utils'
+command_args = [ task ] + ARGV if task
+
+PgxnUtils::CLI.start( command_args || ARGV )

data/lib/pgxn_utils/cli.rb

@@ -1,6 +1,6 @@
 module PgxnUtils
   class CLI < Thor
-    attr_accessor :extension_name, :target, :maintainer, :maintainer_mail
+    attr_accessor :extension_name, :target, :maintainer #, :maintainer_mail
     attr_accessor :abstract, :description, :version, :tags
     attr_accessor :license, :release_status, :generated_by
 
@@ -8,42 +8,122 @@ module PgxnUtils
 
     desc "skeleton extension_name", "Creates an extension skeleton in current directory."
 
-    method_option :target,            :aliases => "-p", :default => ".",    :desc => "Define the target directory"
+    method_option :target,            :aliases => "-p", :default => ".",  :desc => "Define the target directory"
 
     # META required fields
-    method_option :maintainer,        :aliases => "-m", :type => :string,   :default => "The maintainer's name", :desc => "Maintainer's name"
-    method_option :maintainer_mail,   :aliases => "-e", :type => :string,   :default => "maintainer@email.here", :desc => "Maintainer's mail"
-    method_option :abstract,          :aliases => "-a", :type => :string,   :default => "A short description",   :desc => "Defines a short description to abstract"
-    method_option :license,           :aliases => "-l", :type => :string,   :default => "postgresql",            :desc => "The extension license."
-    method_option :version,           :aliases => "-v", :type => :string,   :default => "0.0.1",                 :desc => "Initial version"
+    method_option :maintainer,        :aliases => "-m", :type => :string, :desc => "Maintainer's name <maintainer@email>"
+    #method_option :maintainer_mail,   :aliases => "-e", :type => :string, :desc => "Maintainer's mail"
+    method_option :abstract,          :aliases => "-a", :type => :string, :desc => "Defines a short description to abstract"
+    method_option :license,           :aliases => "-l", :type => :string, :desc => "The extension license."
+    method_option :version,           :aliases => "-v", :type => :string, :desc => "Initial version"
 
     # META optional fields
-    method_option :description,       :aliases => "-d", :type => :string,  :default => "A long description",     :desc => "A long text that contains more information about extension"
-    method_option :generated_by,      :aliases => "-b", :type => :string,                                        :desc => "Name of extension's generator"
-    method_option :tags,              :aliases => "-t", :type => :array,                                         :desc => "Defines extension's tags"
-    method_option :release_status,    :aliases => "-r", :type => :string,  :default => "unstable",               :desc => "Initial extension's release status"
+    method_option :description,       :aliases => "-d", :type => :string, :desc => "A long text that contains more information about extension"
+    method_option :generated_by,      :aliases => "-b", :type => :string, :desc => "Name of extension's generator"
+    method_option :tags,              :aliases => "-t", :type => :array,  :desc => "Defines extension's tags"
+    method_option :release_status,    :aliases => "-r", :type => :string, :desc => "Initial extension's release status"
 
-    def skeleton(extension_name)
+    def skeleton(extension_name,target=nil)
+      self.target = options[:target] || target || "."
       self.set_accessors extension_name
 
       directory "root", extension_name
     end
 
+    desc "change [extension_name]", "Change META's attributes in current extension."
+
+    # META required fields
+    method_option :maintainer,        :aliases => "-m", :type => :string, :desc => "Maintainer's name <maintainer@email>"
+    #method_option :maintainer_mail,   :aliases => "-e", :type => :string, :desc => "Maintainer's mail"
+    method_option :abstract,          :aliases => "-a", :type => :string, :desc => "Defines a short description to abstract"
+    method_option :license,           :aliases => "-l", :type => :string, :desc => "The extension license."
+    method_option :version,           :aliases => "-v", :type => :string, :desc => "Initial version"
+
+    # META optional fields
+    method_option :description,       :aliases => "-d", :type => :string, :desc => "A long text that contains more information about extension"
+    method_option :generated_by,      :aliases => "-b", :type => :string, :desc => "Name of extension's generator"
+    method_option :tags,              :aliases => "-t", :type => :array,  :desc => "Defines extension's tags"
+    method_option :release_status,    :aliases => "-r", :type => :string, :desc => "Initial extension's release status"
+
+    def change(extension_name=".")
+      path = File.expand_path(extension_name)
+
+      target = File.expand_path('..', path)
+      extension_name = File.basename(path)
+
+      skeleton(extension_name, target)
+    end
+
+    desc "bundle [extension_name]", "Bundles an extension."
+
+    def bundle(extension_name=".")
+      unless is_extension?(extension_name)
+        say "'#{extension_name}' isn't a valid extension"
+      else
+        path = File.expand_path(extension_name)
+        extension_name = File.basename(path)
+
+        self.target = path
+        archive_name = "#{path}-#{config_options['version']}"
+        ext = "zip"
+        archive = "#{archive_name}.#{ext}"
+
+        if can_zip?(archive)
+          Zippy.create(archive) do |zip|
+            Dir["#{path}/**/**"].each do |file|
+              zip["#{extension_name}-#{config_options['version']}/#{file.sub(path+'/','')}"] = File.open(file) unless File.directory?(file)
+            end
+          end
+          say "Extension generated at: #{archive}"
+        end
+      end
+    end
+
     no_tasks do
+      def can_zip?(archive)
+        can_zip = false
+
+        if File.exists?(archive)
+          if yes? "#{archive} found! Overwrite? [yN]"
+            can_zip = true
+          else
+            can_zip = false
+          end
+        else
+          can_zip = true
+        end
+      end
+
+      def is_extension?(dir=".")
+        File.directory?(dir) && File.exists?("#{dir}/META.json")
+      end
+
+      def config_options
+        file = ""
+        file = File.join(file, self.target) if self.target != "."
+        file = File.join(file, self.extension_name) if self.extension_name
+        file = File.join(file, "META.json")
+
+        if File.exist?(file)
+          @@config_options ||= JSON.load(File.read(file))
+        else
+          {}
+        end
+      end
+
       def set_accessors(extension_name="your_extension_name")
         self.extension_name = extension_name
 
-        self.target = options[:target]
-        self.maintainer = options[:maintainer]
-        self.maintainer_mail = options[:maintainer_mail]
-        self.abstract = options[:abstract]
-        self.license = options[:license]
-        self.version = options[:version]
-
-        self.description = options[:description]
-        self.generated_by = options[:generated_by]
-        self.tags = options[:tags]
-        self.release_status = options[:release_status]
+        self.maintainer      = options[:maintainer]      || config_options["maintainer"]      || "The maintainer's name"
+        #self.maintainer_mail = options[:maintainer_mail] || config_options["maintainer_mail"] || "maintainer@email.here"
+        self.abstract        = options[:abstract]        || config_options["abstract"]        || "A short description"
+        self.license         = options[:license]         || config_options["license"]         || "postgresql"
+        self.version         = options[:version]         || config_options["version"]         || "0.0.1"
+
+        self.description     = options[:description]     || config_options["description"]     || "A long description"
+        self.generated_by    = options[:generated_by]    || config_options["generated_by"]    || maintainer
+        self.tags            = options[:tags]            || config_options["tags"]
+        self.release_status  = options[:release_status]  || config_options["release_status"]  || "unstable"
 
         self.destination_root = target
       end

data/lib/pgxn_utils/templates/root/META.json.tt

@@ -3,7 +3,7 @@
    "abstract": "<%= abstract %>",
    "description": "<%= description %>",
    "version": "<%= version %>",
-   "maintainer": "<%= maintainer %> <<%= maintainer_mail %>>",
+   "maintainer": "<%= maintainer %>",
    "license": "<%= license %>",
    "provides": {
       "<%= extension_name %>": {

data/lib/pgxn_utils/templates/root/sql/%extension_name%.sql.tt

@@ -1,5 +1,5 @@
 /*
- * Author: <%= maintainer %> <<%= maintainer_mail %>>
+ * Author: <%= maintainer %>
  * Created at: <%= Time.now %>
  *
  */ 

data/lib/pgxn_utils/version.rb

@@ -1,3 +1,3 @@
 module PgxnUtils
-  VERSION = "0.0.4"
+  VERSION = "0.1.1"
 end

data/lib/pgxn_utils.rb

@@ -1,4 +1,7 @@
 require 'thor'
+require 'json'
+require 'zip/zip'
+require 'zippy'
 
 module PgxnUtils
  autoload :CLI, 'pgxn_utils/cli'

data/pgxn_utils.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Dickson S. Guedes"]
   s.email       = ["guedes@guedesoft.net"]
   s.homepage    = "http://github.com/guedes/pgxn-utils"
-  s.summary     = %q{A PGXN set of tools to developers}
+  s.summary     = %q{A PGXN set of tools to PostgreSQL extension's developers}
   s.description = %q{A PGXN set of tools to help developers create and publish your PostgreSQL extensions without pain}
 
   s.rubyforge_project = "pgxn_utils"
@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
 
   # dev
   s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov", ">= 0.4.0"
 
   # prod
   if s.respond_to? :specification_version then
@@ -29,10 +30,16 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<thor>, ["~> 0.14"])
+      s.add_runtime_dependency(%q<rubyzip>, ["~> 0.9.4"])
+      s.add_runtime_dependency(%q<zippy>, ["~> 0.1.0"])
     else
       s.add_dependency(%q<thor>, ["~> 0.14"])
+      s.add_runtime_dependency(%q<rubyzip>, ["~> 0.9.4"])
+      s.add_runtime_dependency(%q<zippy>, ["~> 0.1.0"])
     end
   else
     s.add_dependency(%q<thor>, ["~> 0.14"])
+    s.add_runtime_dependency(%q<rubyzip>, ["~> 0.9.4"])
+    s.add_runtime_dependency(%q<zippy>, ["~> 0.1.0"])
   end
 end

data/spec/cli_spec.rb

@@ -7,7 +7,7 @@ describe PgxnUtils::CLI do
     system "rm -rf extension.*"
   end
 
-  context "create skeleton" do
+  context "#skeleton" do
     before(:each) do
       @cli = PgxnUtils::CLI.new
     end
@@ -42,10 +42,12 @@ describe PgxnUtils::CLI do
       meta.should match(/"version": "#{expected_version}"/)
       meta.should match(/"license": "postgresql"/)
       meta.should match(/"release_status": "unstable"/)
-      meta.should match(/"#{expected_name} <#{expected_mail}>"/)
+      #TODO: I want define how split this from META
+      #meta.should match(/"#{expected_name} <#{expected_mail}>"/)
+      meta.should match(/"#{expected_name}"/)
       meta.should match(/"file": "sql\/#{expected_extension}.sql"/)
       meta.should match(/"docfile": "doc\/#{expected_extension}.md"/)
-      meta.should_not match(/"generated_by":/)
+      meta.should_not match(/"generated_by": #{expected_name}/)
       meta.should match(/"tags": \[ "one","two","tree" \],/)
 
       makefile = File.read("/tmp/#{expected_extension}/Makefile")
@@ -81,12 +83,16 @@ describe PgxnUtils::CLI do
     it "should generates a git repo"
   end
 
-  context "bundle" do
+  context "#change" do
+    it "should change things"
+  end
+
+  context "#bundle" do
     it "should bundle to zip by default"
     it "should create the name in semver spec"
   end
 
-  context "release" do
+  context "#release" do
     it "should send the bundle to PGXN"
   end
 

data/spec/spec_helper.rb

@@ -2,6 +2,8 @@ $:.unshift File.expand_path('..', __FILE__)
 $:.unshift File.expand_path('../../lib', __FILE__)
 
 require 'rspec'
+require 'simplecov'
+SimpleCov.start
 require 'pgxn_utils'
 
 $counter = 0
@@ -21,6 +23,10 @@ def skeleton(extension_name, args=nil)
   run_pgxn_utils(:skeleton, "#{extension_name} #{args}")
 end
 
+def change(extension_name, args=nil)
+  run_pgxn_utils(:skeleton, "#{extension_name} #{args}")
+end
+
 def run_pgxn_utils(task, args)
   system "#{BIN_PATH} #{task.to_s} #{args} >/dev/null"
 end

metadata

@@ -2,7 +2,7 @@
 name: pgxn_utils
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.1.1
 platform: ruby
 authors: 
 - Dickson S. Guedes
@@ -25,16 +25,49 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: thor
+  name: simplecov
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: "0.14"
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rubyzip
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: zippy
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+  type: :runtime
+  version_requirements: *id005
 description: A PGXN set of tools to help developers create and publish your PostgreSQL extensions without pain
 email: 
 - guedes@guedesoft.net
@@ -89,9 +122,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: pgxn_utils
-rubygems_version: 1.5.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: A PGXN set of tools to developers
+summary: A PGXN set of tools to PostgreSQL extension's developers
 test_files: []