6 files changed, 297 insertions, 13 deletions

diff --git a/src/bin/luarocks b/src/bin/luarocks
index b64051d4..e28b17b8 100755
--- a/src/bin/luarocks
+++ b/src/bin/luarocks
@@ -19,6 +19,7 @@ commands.path = require("luarocks.path")
 commands.show = require("luarocks.show")
 commands.new_version = require("luarocks.new_version")
 commands.lint = require("luarocks.lint")
+commands.write_rockspec = require("luarocks.write_rockspec")
 commands.purge = require("luarocks.purge")
 
 command_line.run_command(...)
diff --git a/src/luarocks/fetch.lua b/src/luarocks/fetch.lua
index a742b7fc..111d229a 100644
--- a/src/luarocks/fetch.lua
+++ b/src/luarocks/fetch.lua
@@ -11,6 +11,10 @@ local persist = require("luarocks.persist")
 local util = require("luarocks.util")
 local cfg = require("luarocks.cfg")
 
+function is_basic_protocol(protocol, remote)
+   return protocol == "http" or protocol == "https" or protocol == "ftp" or (not remote and protocol == "file")
+end
+
 --- Fetch a local or remote file.
 -- Make a remote or local URL/pathname local, fetching the file if necessary.
 -- Other "fetch" and "load" functions use this function to obtain files.
@@ -30,7 +34,7 @@ function fetch_url(url, filename)
    local protocol, pathname = dir.split_url(url)
    if protocol == "file" then
       return fs.absolute_name(pathname)
-   elseif protocol == "http" or protocol == "ftp" or protocol == "https" then
+   elseif is_basic_protocol(protocol, true) then
       local ok, err = fs.download(url, filename)
       if not ok then
          return nil, "Failed downloading "..url..(err and " - "..err or ""), "network"
@@ -171,7 +175,7 @@ function load_local_rockspec(filename)
    end
 
    local protocol, pathname = dir.split_url(rockspec.source.url)
-   if protocol == "http" or protocol == "https" or protocol == "ftp" or protocol == "file" then
+   if is_basic_protocol(protocol) then
       rockspec.source.file = rockspec.source.file or dir.base_name(rockspec.source.url)
    end
    rockspec.source.protocol, rockspec.source.pathname = protocol, pathname
@@ -254,7 +258,8 @@ end
 -- @param rockspec table: The rockspec table
 -- @param extract boolean: Whether to extract the sources from
 -- the fetched source tarball or not.
--- @param dest_dir string or nil: If set, will extract to the given directory.
+-- @param dest_dir string or nil: If set, will extract to the given directory;
+-- if not given, will extract to a temporary directory.
 -- @return (string, string) or (nil, string, [string]): The absolute pathname of
 -- the fetched source tarball and the temporary directory created to
 -- store it; or nil and an error message and optional error code.
@@ -301,6 +306,7 @@ end
 -- @param extract boolean: When downloading compressed formats, whether to extract
 -- the sources from the fetched archive or not.
 -- @param dest_dir string or nil: If set, will extract to the given directory.
+-- if not given, will extract to a temporary directory.
 -- @return (string, string) or (nil, string): The absolute pathname of
 -- the fetched source tarball and the temporary directory created to
 -- store it; or nil and an error message.
@@ -311,7 +317,7 @@ function fetch_sources(rockspec, extract, dest_dir)
 
    local protocol = rockspec.source.protocol
    local ok, proto
-   if protocol == "http" or protocol == "https" or protocol == "ftp" or protocol == "file" then
+   if is_basic_protocol(protocol) then
       proto = require("luarocks.fetch")
    else
       ok, proto = pcall(require, "luarocks.fetch."..protocol:gsub("[+-]", "_"))
diff --git a/src/luarocks/fetch/git.lua b/src/luarocks/fetch/git.lua
index 85714eb2..90d4eea8 100644
--- a/src/luarocks/fetch/git.lua
+++ b/src/luarocks/fetch/git.lua
@@ -17,7 +17,7 @@ local function git_can_clone_by_tag(git_cmd)
    major, minor, tiny = tonumber(major), tonumber(minor), tonumber(tiny) or 0
    local value = major > 1 or (major == 1 and (minor > 7 or (minor == 7 and tiny >= 10)))
    git_can_clone_by_tag = function() return value end
-   return git_can_clone_by_tag()
+   return value
 end
 
 --- Download sources for building a rock, using git.
diff --git a/src/luarocks/new_version.lua b/src/luarocks/new_version.lua
index f93d0c29..7f255d0d 100644
--- a/src/luarocks/new_version.lua
+++ b/src/luarocks/new_version.lua
@@ -10,6 +10,7 @@ local fetch = require("luarocks.fetch")
 local persist = require("luarocks.persist")
 local dir = require("luarocks.dir")
 local fs = require("luarocks.fs")
+local type_check = require("luarocks.type_check")
 
 help_summary = "Auto-write a rockspec for a new version of a rock."
 help_arguments = "{<package>|<rockspec>} [<new_version>] [<new_url>]"
@@ -33,13 +34,6 @@ WARNING: it writes the new rockspec to the current directory,
 overwriting the file if it already exists.
 ]]
 
-local order = {"rockspec_format", "package", "version", 
-   { "source", { "url", "tag", "branch", "md5" } },
-   { "description", {"summary", "detailed", "homepage", "license" } },
-   "supported_platforms", "dependencies", "external_dependencies",
-   { "build", {"type", "modules", "copy_directories", "platforms"} },
-   "hooks"}
-
 local function try_replace(tbl, field, old, new)
    if not tbl[field] then
       return false
@@ -166,7 +160,7 @@ function run(...)
    
    local out_filename = out_name.."-"..new_rockver.."-"..new_rev..".rockspec"
    
-   persist.save_from_table(out_filename, out_rs, order)
+   persist.save_from_table(out_filename, out_rs, type_check.rockspec_order)
    
    util.printout("Wrote "..out_filename)
 
diff --git a/src/luarocks/type_check.lua b/src/luarocks/type_check.lua
index 28e6e7b9..6a0ee7e7 100644
--- a/src/luarocks/type_check.lua
+++ b/src/luarocks/type_check.lua
@@ -74,6 +74,13 @@ rockspec_types = {
    }
 }
 
+rockspec_order = {"rockspec_format", "package", "version", 
+   { "source", { "url", "tag", "branch", "md5" } },
+   { "description", {"summary", "detailed", "homepage", "license" } },
+   "supported_platforms", "dependencies", "external_dependencies",
+   { "build", {"type", "modules", "copy_directories", "platforms"} },
+   "hooks"}
+
 function load_extensions()
    rockspec_format = "1.1"
    rockspec_types.deploy = {
diff --git a/src/luarocks/write_rockspec.lua b/src/luarocks/write_rockspec.lua
new file mode 100644
index 00000000..db0bcd44
--- /dev/null
+++ b/src/luarocks/write_rockspec.lua
@@ -0,0 +1,276 @@
+
+module("luarocks.write_rockspec", package.seeall)
+
+local dir = require("luarocks.dir")
+local fetch = require("luarocks.fetch")
+local fs = require("luarocks.fs")
+local path = require("luarocks.path")
+local persist = require("luarocks.persist")
+local type_check = require("luarocks.type_check")
+local util = require("luarocks.util")
+
+help_summary = "Write a template for a rockspec file."
+help_arguments = "[--output=<file> ...] <name> [<version>] [<url>|<path>]"
+help = [[
+This command writes an initial version of a rockspec file,
+based on an URL or a local path.
+
+If a repository URL is given with no version, it creates an 'scm' rock.
+
+Note that the generated file is a _starting point_ for writing a
+rockspec, and is not guaranteed to be complete or correct.
+
+--output=<file>       Write the rockspec with the given filename.
+                      If not given, a file is written in the current
+                      directory with a filename based on given name and version.
+--license="<string>"  A license string, such as "MIT/X11" or "GNU GPL v3".
+--summary="<txt>"     A short one-line description summary.
+--description="<txt>" A longer description string.
+--homepage=<url>      Project homepage.
+--lua-version=<ver>   Supported Lua versions. Accepted values are "5.1", "5.2"
+                      or "5.1,5.2".
+--lib=<lib>[,<lib>]   A comma-separated list of libraries that C files need to
+                      link to.
+]]
+
+
+local function get_url(rockspec)
+   local url = rockspec.source.url
+   local file, temp_dir = fetch.fetch_sources(rockspec, true)
+   if not file then
+      util.warning("Could not fetch sources - "..temp_dir)
+      return false
+   end
+   util.printout("File successfully downloaded. Making checksum and checking base dir...")
+   local md5 = nil
+   if fetch.is_basic_protocol(rockspec.source.protocol) then
+      rockspec.source.md5 = fs.get_md5(file)
+   end
+   local ok, err = fs.change_dir(temp_dir)
+   if not ok then return false end
+   fs.unpack_archive(file)
+   local base_dir = fetch.url_to_base_dir(url)
+   if not fs.exists(base_dir) then
+      util.printerr("Directory "..base_dir.." not found")
+      local files = fs.list_dir()
+      if files[1] and fs.is_dir(files[1]) then
+         util.printerr("Found "..files[1])
+         base_dir = files[1]
+      end
+   end
+   fs.pop_dir()
+   return true, base_dir, temp_dir
+end
+
+local function configure_lua_version(rockspec, luaver)
+   if luaver == "5.1" then
+      table.insert(rockspec.dependencies, "lua ~> 5.1")
+   elseif luaver == "5.2" then
+      table.insert(rockspec.dependencies, "lua ~> 5.2")
+   elseif luaver == "5.1,5.2" then
+      table.insert(rockspec.dependencies, "lua >= 5.1, <= 5.3")
+   else
+      util.warning("Please specify supported Lua version with --lua-version=<ver>. "..util.see_help("write_rockspec"))
+   end
+end
+
+local function detect_description(rockspec)
+   local fd = io.open("README.md", "r")
+   if not fd then fd = io.open("README", "r") end
+   if not fd then return end
+   local data = fd:read("*a")
+   fd:close()
+   local paragraph = data:match("\n\n(.-)\n\n")
+   if not paragraph then paragraph = data:match("\n\n(.*)") end
+   if paragraph then
+      if #paragraph < 80 then
+         rockspec.description.summary = paragraph:gsub("\n", "")
+         rockspec.description.detailed = paragraph
+      else
+         local summary = paragraph:gsub("\n", " "):match("([^.]*%.) ")
+         if summary then
+            rockspec.description.summary = summary:gsub("\n", "")
+         end
+         rockspec.description.detailed = paragraph
+      end
+   end
+end
+
+local function get_cmod_name(file)
+   local fd = io.open(file, "r")
+   if not fd then return nil end
+   local data = fd:read("*a")
+   fd:close()
+   return (data:match("int%s+luaopen_([a-zA-Z0-9_]+)"))
+end
+
+local luamod_blacklist = {
+   test = true,
+   tests = true,
+}
+
+local function fill_as_builtin(rockspec, libs)
+   rockspec.build.type = "builtin"
+   rockspec.build.modules = {}
+   local prefix = ""
+
+   for _, parent in ipairs({"src", "lua"}) do
+      if fs.is_dir(parent) then
+         fs.change_dir(parent)
+         prefix = parent.."/"
+         break
+      end
+   end
+   
+   local incdirs, libdirs
+   if libs then
+      incdirs, libdirs = {}, {}
+      for _, lib in ipairs(libs) do
+         local upper = lib:upper()
+         incdirs[#incdirs+1] = "$("..upper.."_INCDIR)"
+         libdirs[#libdirs+1] = "$("..upper.."_LIBDIR)"
+      end
+   end
+
+   for _, file in ipairs(fs.find()) do
+      local luamod = file:match("(.*)%.lua$")
+      if luamod and not luamod_blacklist[luamod] then
+         rockspec.build.modules[path.path_to_module(file)] = prefix..file
+      else
+         local cmod = file:match("(.*)%.c$")
+         if cmod then
+            local modname = get_cmod_name(file) or path.path_to_module(file:gsub("%.c$", ".lua"))
+            rockspec.build.modules[modname] = {
+               sources = prefix..file,
+               libraries = libs,
+               incdirs = incdirs,
+               libdirs = libdirs,
+            }
+         end
+      end
+   end
+   
+   for _, directory in ipairs({ "doc", "docs", "samples", "tests" }) do
+      if fs.is_dir(directory) then
+         if not rockspec.build.copy_directories then
+            rockspec.build.copy_directories = {}
+         end
+         table.insert(rockspec.build.copy_directories, directory)
+      end
+   end
+   
+   if prefix ~= "" then
+      fs.pop_dir()
+   end
+end
+
+local function rockspec_cleanup(rockspec)
+   rockspec.source.protocol = nil
+   rockspec.variables = nil
+   rockspec.name = nil
+end
+
+function run(...)
+   local flags, name, version, local_dir = util.parse_flags(...)
+   
+   if not name then
+      return nil, "Missing arguments. "..util.see_help("write_rockspec")
+   end
+
+   if name and not version then
+      local protocol, path = dir.split_url(name)
+      if not fetch.is_basic_protocol(protocol) then
+         name = dir.base_name(name):gsub("%.[^.]+$", "")
+         version = "scm"
+         local_dir = name
+      else
+         return nil, "Missing name and version arguments. "..util.see_help("write_rockspec")
+      end
+   end
+
+   if not local_dir then
+      local protocol, path = dir.split_url(version)
+      if not fetch.is_basic_protocol(protocol) then
+         local_dir = version
+         version = "scm"
+      elseif protocol ~= "file" then
+         return nil, "Missing version argument. "..util.see_help("write_rockspec")
+      end
+   end
+
+   local filename = flags["output"] or dir.path(fs.current_dir(), name:lower().."-"..version.."-1.rockspec")
+
+   local rockspec = {
+      package = name,
+      name = name:lower(),
+      version = version.."-1",
+      source = {
+         url = "*** please add URL for source tarball, zip or repository here ***"
+      },
+      description = {
+         summary = flags["summary"] or "*** please specify description summary ***",
+         detailed = flags["detailed"] or "*** please enter a detailed description ***",
+         homepage = flags["homepage"] or "*** please enter a project homepage ***",
+         license = flags["license"] or "*** please specify a license ***",
+      },
+      dependencies = {},
+      build = {},
+   }
+   path.configure_paths(rockspec)
+   rockspec.source.protocol = dir.split_url(local_dir)
+   
+   configure_lua_version(rockspec, flags["lua-version"])
+
+   if local_dir:match("://") then
+      rockspec.source.url = local_dir
+      if not fetch.is_basic_protocol(rockspec.source.protocol) then
+         if version ~= "scm" then
+            rockspec.source.tag = "v" .. version
+         end
+      end
+      local ok, base_dir, temp_dir = get_url(rockspec)
+      if ok then
+         if base_dir ~= dir.base_name(local_dir) then
+            rockspec.source.dir = base_dir
+         end
+      end
+      if base_dir then
+         local_dir = dir.path(temp_dir, base_dir)
+      else
+         local_dir = nil
+      end
+   end
+   
+   if not local_dir then
+      local_dir = "."
+   end
+   
+   local libs = nil
+   if flags["lib"] then
+      libs = {}
+      rockspec.external_dependencies = {}
+      for lib in flags["lib"]:gmatch("([^,]+)") do
+         table.insert(libs, lib)
+         rockspec.external_dependencies[lib:upper()] = {
+            library = lib
+         }
+      end
+   end
+
+   local ok, err = fs.change_dir(local_dir)
+   if not ok then return nil, "Failed reaching files from project - error entering directory "..local_dir end
+
+   detect_description(rockspec)
+   
+   fill_as_builtin(rockspec, libs)
+      
+   rockspec_cleanup(rockspec)
+   
+   persist.save_from_table(filename, rockspec, type_check.rockspec_order)
+
+   util.printout()   
+   util.printout("Wrote template at "..filename.." -- you should now edit and finish it.")
+   util.printout()   
+
+   return true
+end