ian 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcf55fe8183aa26141bafc1011ff313f325531ff
-  data.tar.gz: 43770450bb488b08e7b546274ecefc0646b133df
+  metadata.gz: 275263c7fe3189b9bcf5abcde074c7e6e1ea259e
+  data.tar.gz: c9874e5c5b93b50ee4712dd1cd20b50cd44d9823
 SHA512:
-  metadata.gz: c705fadaad72699deedc70fd6e1a34c9bd8f2dcb44563dc0336b5aac206a0e80e203259d0c06dbc39b9824946fdb896a2e2a52a3cdae8556c802d9ae75510a22
-  data.tar.gz: 0b0fe9a490eb2c685ad2f831c0995691b20ab44211f9cc82b9eef41260e65dd9d96657c28ff5688507462e9be2c11cba8048f7630e0eafc8deeacc1bfa7f82d3
+  metadata.gz: 08d1503a29ac3a3ded30c8ebe8d9f37e76e3f4b821e0005a5079e0576c202ee5be82ac87de7a39c1bb6717eb6e755cbbef2acc71b7b9630098b8f51cf4d99ffd
+  data.tar.gz: af8ab880603887338802c7d3e36fedfd60a554f410ae4b8013148bf4dd1b9a8e286cb8fc5cc34caa644adeabe8708892542c07a47f056309d681c4ad28705064

data/README.md

@@ -2,8 +2,8 @@
 
 A Debian CLI package hacking tool named in memory of the late Ian Murdock.
 
-This tool will help you to create and maintain the source repos for Debain
-packages and tries to mimic the CLI of other popular tools such as git and
+This tool will help you to create and maintain git repositories that contain simple
+Debian packages and tries to mimic the CLI of other popular tools such as git and
 bundler.
 
 It is intended to be helpful when integrating other build tools/systems and
@@ -27,35 +27,101 @@ Or install it yourself as:
 
 ## Usage
 
-Create a new package (like `bundle new gemname`):
+This tool is used for working with what Debian called "Binary packages" - that is
+ones that have the `DEBIAN` folder in capitals to slap Debian packages together
+quickly.  It uses `dpkg-deb -b` in the background which most Debian package
+maintainers frown at but it is suitable enough for rolling your own packages
+quickly, and it scratches an itch.
+
+Help is available using `-h` or `--help` with all commands.
+
+**Create a new package** (like `bundle new gemname`):
 
     $ ian new mycoolpackage
 
-Init an existing directory (like `git init`):
+This will create a folder called `mycoolpackage` as well as the `DEBIAN` folder
+inside it, a `control` file with defaults and a `postinst` file.  It will also
+create an .ianignore file for stuff you don't want in the package.
+
+**Init an existing directory** (like `git init`):
 
     $ ian init
 
-Show the info for the package (basically `cat DEBAIN/control`):
+This does the same as the `new` command but assumes you are already in the folder
+called `mycoolpackage`.
+
+**Show info for the package** (basically `cat DEBAIN/control`):
 
     $ ian info
 
-Set info in the control file:
+This will print the control file as parsed by ian.  It will also warn you if you
+are missing a mandatory field.
+
+**Dependencies**:
+
+This prints the dependencies from the control file each on a separate line:
+
+    $ ian deps
+
+**Set info in the control file**:
 
     $ ian set -v 2.3.1-beta
     $ ian set -a amd64
 
-Build a package:
+Using this you can programatically set the version or architecture in the control
+file.
+
+**Build a package**:
 
     $ ian pkg
 
-Before building a package ian will determine the installed size, leave out any
-cruft (such as the `.git` directory) and move READMEs and the like to `/usr/share/doc`.
+Before building a package ian will determine the installed size and save it to
+the control file.  Then the contents are rsynced to a temp dir, excluding the `.git`
+folder, the `.gitignore` and `.ianignore` files, as well as anything specified in
+the `.ianignore` file.
+
+Any files left in the root of the package will be moved to `/usr/share/doc` under
+a folder of the same name as the generated package.
+
+Finally the package is built into a `pkg` folder in the format `name_version_arch`.
+
+**Releasing a package**:
+
+Tagging commits with the package version can be done using this command:
+
+    $ ian release
+
+This takes the version from the control file, tags the current commit with that
+version (prepending it with a `v`) and then builds the package as above.
+
+    $ ian release 4.2.8-beta
+
+This does the same as before, however first it will take the version number in
+the argument, write it to the control file and commit the control file.
+
+**Show versions**:
+
+Show the versions by using this command:
+
+    $ ian versions
+
+## Help
+
+Need help with the control files?  Try these links:
+
+* https://www.debian.org/doc/debian-policy/ch-controlfields.html
+* https://www.debian.org/doc/debian-policy/ch-relationships.html
 
 ## TODO
 
 - [ ] MD5sums generation
 - [x] finish package generation code
-- [ ] ADD SPECS!!!!
+- [x] ADD SPECS!!!!
+- [ ] ADD MORE SPECS!!!!
+- [ ] Nicer output
+- [ ] add commands to help with releasing new versions/tagging
+- [ ] allow packaging past versions from git tags
+- [ ] add option for semver enforcement
 
 ## Development
 

data/bin/ian

@@ -11,12 +11,17 @@ def initialized?
   File.exist?("#{IAN_DIR}/DEBIAN/control")
 end
 
+def check_initialized!
+  abort "ERROR: Not initialized" unless initialized?
+end
+
 log = Logger.new(STDOUT)
 
 Slop.parse help: true do
 
   on :v, "Print the version" do
-    puts Ian::VERSION
+    puts "Version %s" % [Ian::VERSION]
+    puts "In memory of Ian Ashley Murdock (1973 - 2015)"
     exit
   end
 
@@ -34,7 +39,7 @@ Slop.parse help: true do
         abort "Directory '#{name}' exists"
       end
 
-      Ian.create(name)
+      Ian.create(name, log)
     end
   end
 
@@ -52,6 +57,8 @@ Slop.parse help: true do
     description "Build a Debian package"
 
     run do |opts, args|
+      check_initialized!
+
       pkg = Ian.build_package(IAN_DIR, log)
       log.info "Package built to #{pkg}"
     end
@@ -64,6 +71,8 @@ Slop.parse help: true do
     on :a, :arch=,      "Change the architecture"
 
     run do |opts, args|
+      check_initialized!
+      
       c = Ian.control(IAN_DIR)
       c.update(opts.to_hash)
       c.save
@@ -75,14 +84,24 @@ Slop.parse help: true do
     description "Print information for this package"
 
     run do |opts, args|
-      puts Ian.control(IAN_DIR)
+      check_initialized!
+
+      c = Ian.control(IAN_DIR)
+      puts c
+
+      unless c.valid?
+        puts "\n"
+        log.warn "Control file is not valid, missing mandatory fields: %s" % c.missing_mandatory_fields
+      end
     end
   end
 
   command :deps do
     description "Print dependencies for this package"
 
-    run do |opts, args|
+    run do |opts, args| 
+      check_initialized!
+
       ctrl = Ian.control(IAN_DIR)
       ctrl[:depends].each do |dep|
         puts dep
@@ -90,4 +109,48 @@ Slop.parse help: true do
     end
   end
 
+  command :versions do
+    description "Show all the known versions"
+
+    run do |opts, args|
+      check_initialized!
+
+      %x[git tag].scan(/^v.*$/).each do |v|
+        puts v
+      end
+    end
+  end
+
+  command :release do
+    description "Release the current or new version"
+    banner "Usage: ian release [version]\n\nBy omitting the version, the one in the control file will be used\n"
+
+    run do |opts, args|
+      check_initialized!
+
+      ctrl = Ian.control(IAN_DIR)
+      version = ctrl[:version]
+
+      if args.any?
+        version = args.first
+        version.gsub!(/^v/, '')
+        log.info "Releasing v#{version}"
+        log.info "Updating control file"
+        ctrl[:version] = version
+        ctrl.save
+
+        log.info "Committing control file"
+        system "git add #{ctrl.path}"
+        system "git commit -m 'releasing v#{version}'"
+
+      end
+
+      log.info "Tagging v#{version}"
+      system "git tag v#{version}"
+
+      pkg = Ian.build_package(IAN_DIR, log)
+      log.info "Package built to #{pkg}"
+    end
+  end
+
 end

data/lib/ian.rb

@@ -18,25 +18,34 @@ module Ian
       "#{debpath(path)}/control"
     end
 
-    def create(name)
-      FileUtils.mkdir(name)
+    # create a new DEBIAN package
+    def create(name, log)
+      path = File.expand_path(name)
+      FileUtils.mkdir(path)
 
-      init(name)
+      init(path, log)
     end
 
+    # initialize a new DEBIAN package
     def init(path, log)
-      FileUtils.mkdir(debpath(path))
+      dpath = debpath(path)
+      cpath = ctrlpath(path)
+   
+      FileUtils.mkdir_p(dpath)
+      log.info "Created DEBIAN folder"
 
-      control(path).save
-      log.info "Generated #{path}"
+      c = Control.default
+      c[:package] = File.basename(path)
+      Control.save(c, cpath)
+      log.info "Generated #{cpath}"
 
-      pi = "#{debpath(path)}/postinst"
+      pi = "#{dpath}/postinst"
 
       File.write(pi, "#!/bin/bash\n\n\nexit 0;")
       log.info "Generated #{pi}"
 
-      FileUtils.chmod(0755, Dir["#{debpath(path)}/*"])
-      FileUtils.chmod(0755, debpath(path))
+      FileUtils.chmod(0755, Dir["#{dpath}/*"])
+      FileUtils.chmod(0755, dpath)
 
       #cfg = {}
 
@@ -47,8 +56,13 @@ module Ian
       log.info "Generated .ianignore"
     end
 
-    def control(path)
-      Ian::Control.new(ctrlpath(path))
+    def control(path=nil)
+      if path.nil?
+        return Control.default
+      else
+        path = ctrlpath(path) if File.basename(path) != "DEBIAN"
+        return Control.load_file(path)
+      end
     end
 
     def build_package(path, log)
@@ -60,7 +74,6 @@ module Ian
       pkgr.run
     end
 
-
   end
 
 end

data/lib/ian/control.rb

@@ -1,20 +1,16 @@
-module Ian
-  class Control
-    attr_reader :path
+require 'ian/utils'
 
-    def initialize(path)
-      @path = path
+module Ian
+  class ValidationError < StandardError; end
 
-      if File.exist?(@path)
-        parse
-      else
-        @fields = defaults
-      end
+  class Control
+    def initialize(**fields)
+      @fields = fields
     end
 
     # allow setting fields directly
     def []=(field, value)
-      raise ArgumentError, "Invalid field: #{field}" unless defaults.keys.include?(field)
+      valid_field!(field)
       @fields[field] = value
     end
 
@@ -23,30 +19,24 @@ module Ian
       @fields[field]
     end
 
-    # parse this control file into the fields hash
-    def parse
-      text = File.read(@path)
-
-      @fields = {}
-
-      fields.each do |f, name|
-        m = text.match(/^#{name}: (.*)$/)
-        next unless m
-        @fields[f] = m[1]
-      end
-
-      if @fields[:depends]
-        @fields[:depends] = @fields[:depends].split(",").map! {|d| d.strip }
-      end
-
-      @fields[:long_desc] = text.scan(/^  (.*)$/).flatten
+    # deletes a field from the hash
+    def delete(field)
+      field.to_sym if field.is_a? String
+      valid_field!(field)
+      raise ArgumentError, "Cannot remove mandatory field #{field.to_s}" if mandatory_fields.include?(field)
+      @fields.delete(field)
     end
 
-    # update a bunch of fields
+    # update a bunch of fields at a time
     def update(hash)
-      hash.each do |k, v|
-        if fields.keys.include?(k) and v
-          @fields[k] = v
+      hash.each do |key, value|
+        valid_field!(key)
+        raise ArgumentError, "Value for #{key} was empty" if value.nil? or value == ""
+
+        if self.class.relationship_fields.include?(key)
+          @fields[key] = value.split(",").map {|d| d.strip }
+        else
+          @fields[key] = value
         end
       end
     end
@@ -55,16 +45,20 @@ module Ian
     def to_s
       lines = []
 
+      # build the standard fields
       [:package, :version, :section, :priority, :arch, :essential, :size, :maintainer, :homepage].each do |key|
         lines << "#{fields[key]}: #{@fields[key]}"
       end
 
-      if @fields[:depends] and @fields[:depends].any?
-        lines << "Depends: #{@fields[:depends].join(", ")}"
+      # build the relationship fields that have been exploded into an array
+      self.class.relationship_fields.each do |key|
+        next unless @fields[key] and @fields[key].any?
+        lines << "%s: %s" % [ self.class.fields[key], @fields[key].join(", ") ]
       end
 
       lines << "Description: #{@fields[:desc]}"
 
+      # build the long description with the double space at the start for each line
       lines += @fields[:long_desc].map do |ld|
         "  #{ld}"
       end
@@ -74,32 +68,31 @@ module Ian
     end
 
     # save the control file to disk
-    def save
-      File.write(@path, to_s)
-    end
-
-    # TODO: move this out of here
-    def guess_maintainer
-      text = File.read("#{ENV['HOME']}/.gitconfig")
-      name = text.match(/name = (.*)$/)[1]
-      email = text.match(/email = (.*)$/)[1]
-
-      "#{name} <#{email}>"
-    rescue
-      return ""
+    # raises Ian::ValidationError
+    def self.save(ctrl, path)
+      c.valid!
+      File.write(path, c.to_s)
     end
 
-    def defaults
+    # default values for a new control file
+    def self.defaults
       {
         package:          "name",
         priority:         "optional",
         section:          "misc",
         essential:        "no",
         size:             0,
-        maintainer:       guess_maintainer,
+        maintainer:       Utils.guess_maintainer,   # TODO: pass the maintainer in somehow
         homepage:         "http://example.com",
         arch:             "all",
         version:          "0.0.1",
+        replaces:         [],
+        conflicts:        [],
+        breaks:           [],
+        recommends:       [],
+        suggests:         [],
+        enhances:         [],
+        predepends:       [],
         depends:          [],
         desc:            "This is a description",
         long_desc:       [
@@ -109,10 +102,18 @@ module Ian
       }
     end
 
-    def fields
+    # a map of field symbols to field names
+    def self.fields
       {
         package:     "Package",
         depends:     "Depends",
+        replaces:    "Replaces",
+        breaks:      "Breaks",
+        conflicts:   "Conflicts",
+        recommends:  "Recommends",
+        suggests:    "Suggests",
+        enhances:    "Enhances",
+        predepends:  "Pre-Depends",
         version:     "Version",
         priority:    "Priority",
         section:     "Section",
@@ -121,9 +122,72 @@ module Ian
         maintainer:  "Maintainer",
         homepage:    "Homepage",
         arch:        "Architecture",
-        desc:        "Description"
+        desc:        "Description",
+        long_desc:   "  "
       }
     end
 
+    def self.relationship_fields
+      [:replaces, :conflicts, :recommends, :suggests, :enhances, :predepends, :depends, :breaks]
+    end
+
+    # return the mandatory fields that are missing from the control file
+    def missing_mandatory_fields
+      mandatory_fields.map do |f|
+        return f unless @fields.keys.include?(f)
+      end.reject {|f| f.nil? }
+    end
+
+    # an array of mandatory fields for a control file
+    def mandatory_fields
+      [:package, :version, :arch, :maintainer, :desc, :long_desc]
+    end
+
+    # checks if the control file is valid
+    def valid?
+      missing_mandatory_fields.empty?
+    end
+
+    def valid!
+      raise ValidationError, "Missing mandatory control fields: #{missing_mandatory_fields.join(",")}" unless valid?
+    end
+
+    def valid_field?(key)
+      self.class.fields.keys.include? key
+    end
+
+    def valid_field!(key)
+      raise ArgumentError, "Invalid field: #{key}" unless valid_field?(key)
+    end
+
+    def self.load_file(path)
+      self.new(self.parse(File.read(path)))
+    end
+
+    # parse this control file into the fields hash
+    def self.parse(text)
+      fields = {}
+
+      self.fields.each do |f, name|
+        m = text.match(/^#{name}: (.*)$/)
+        next unless m
+        fields[f] = m[1]
+      end
+
+      # for the relations fields, split the string out into an array
+      self.relationship_fields.each do |key|
+        next unless fields[key]
+        fields[key] = fields[key].split(",").map! {|d| d.strip }
+      end
+
+      fields[:long_desc] = text.scan(/^  (.*)$/).flatten
+      
+      return fields
+    end
+
+    def self.default
+      self.new(self.defaults)
+    end
+
   end
 end

data/lib/ian/packager.rb

@@ -61,7 +61,7 @@ module Ian
     def build
       pkgdir = File.join(@path, "pkg")
       FileUtils.mkdir_p pkgdir
-    
+
       FileUtils.chmod(0755, Dir["#{Ian.debpath(@dir)}/*"])
       FileUtils.chmod(0755, Ian.debpath(@dir))
 
@@ -97,14 +97,15 @@ module Ian
 
     def excludes
       files = %w[.git .gitignore .ianignore]
-      
+
+      return files unless File.exist?(".ianignore")
       File.read(File.join(@path, ".ianignore")).lines.each do |ign|
         next if ign.start_with? "#"
-        
+
         ign.chomp!
         igns = Dir["#{@path}/#{ign}"]
         next if igns.empty?
-        
+
         files+= igns
       end
     end

data/lib/ian/utils.rb

@@ -6,5 +6,16 @@ module Ian
       %x[du #{path} -ks --exclude=".git"].split.first
     end
 
+    # try to guess the maintainer by reading the git config file
+    def guess_maintainer
+      text = File.read(File.join(ENV['HOME'], ".gitconfig"))
+      name = text.match(/name = (.*)$/)[1]
+      email = text.match(/email = (.*)$/)[1]
+
+      "#{name} <#{email}>"
+    rescue Errno::ENOENT
+      return ""
+    end
+
   end
 end

data/lib/ian/version.rb

@@ -1,3 +1,3 @@
 module Ian
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ian
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Robert McLeod
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-19 00:00:00.000000000 Z
+date: 2016-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop