hackademic 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6fd35f68a4a0d43e53d5baf797570ae6fbb8b4e
-  data.tar.gz: bff3fa30451d396c5585c6d9d08d29c762c7c971
+  metadata.gz: c2e7259df01f7ad5ae1790905497a2455230fd8a
+  data.tar.gz: 682e0d0194273a23ba78c8853b66b6fbe8454a2e
 SHA512:
-  metadata.gz: 95a1282ccc6dee89182d6e481299477ee3c326893982f723f72251ea37efa85b80a7cfe5ac0cf20f73b052843ae5db6651929abe1e892196c5ce88852934067e
-  data.tar.gz: 88bb3931469fd60ffef1778713ea8d988cb80ff7313368f210c1d0edba59845e9cefc9f7f10e0d41d5ee5a364b6b7933307c8dd39dd510513bade5c96afa0f5d
+  metadata.gz: 2caeaaf5f13b5452ab6fd9cade812ffa2fb944d2d7b27ceebf760a6eb20f419a0ab54254ec3bb5c717992291611d238bf8cd9f57983f84bda6ef5c7bd7c79444
+  data.tar.gz: 63ed6080284fc0265f53da0c5956c8f6ebda3133b2267d90cbb89d971168ed0dc83dd07b726a3f84c7570488361254531c76a7d1b23b43b5f3a8fe8197226d3a

data/README.md

@@ -5,6 +5,6 @@
 ### Hackademic manages your plain-text academic workflow
 
 
-© 2016 Kizmeta and Matthew Petty [\@lodestone](https://git.io/lodestone)
+© 2016 Kizmeta and Matthew Petty [@lodestone](https://git.io/lodestone)
 
 LICENSE MIT

data/hackademic.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'hackademic'
-  s.version       = '0.1.3'
+  s.version       = '0.2.0'
   s.date          = '2016-01-03'
   s.summary       = "Create and manage your academic workflow"
   s.description   = "Hackademic manages your plain-text academic workflow."

data/lib/hackademic.rb

@@ -7,55 +7,107 @@ class Hackademic < Thor
 
   include Thor::Actions
 
-  Hackademic.source_root('$HOME')
+  Hackademic.source_root('$HOME/Dropbox')
 
-  desc "setup [DIRECTORY]", "Setup a new Hackademic repository at [DIRECTORY]"
-  def setup(directory)
+  desc "setup [FOLDER]", "Setup a new Hackademic repository at [FOLDER]"
+  def setup(root_directory)
 
-    say "--------------------------------------------------------------", :blue
-    say "Hackademic Setup:", :blue
+    say "--------------------------------------------------------------", :cyan
+    say "Hackademic Setup:", :green
+    say "⫸⫸⫸ Setting up main Hackademic folder structure:", :yellow
 
+    directory = "#{root_directory}/Hackademic"
     empty_directory(directory)
-    empty_directory("#{directory}/Libraries")
-    empty_directory("#{directory}/Libraries/_MINE")
-    empty_directory("#{directory}/Meta")
-    empty_directory("#{directory}/Notes")
-    empty_directory("#{directory}/Projects")
+
+    empty_directory "#{directory}/Libraries"
+    empty_directory "#{directory}/Libraries/My-Library"
+    create_file "#{directory}/Libraries/My-Library/References.bib"
+
+    empty_directory "#{directory}/Meta"
+
+    say "⫸⫸⫸ Initializing version control (git) for Notes database:", :yellow
+    empty_directory "#{directory}/Notes"
+    create_file "#{directory}/Notes/SampleNote.md"
+    unless File.exists? "#{directory}/Notes/.git"
+      inside "#{directory}/Notes" do
+        run "git init ."
+        run "git add ."
+        run "git commit -m 'Initial commit of Notes Database'"
+      end
+    end
+
+    empty_directory "#{directory}/Projects"
+
+    say "»»»»» Done!", :green
+    say "--------------------------------------------------------------", :cyan
 
   end
 
-  desc "new [PROJECT]", "Setup a new Hackademic project called [PROJECT]"
-  def new(project)
+  desc "new [PROJECTNAME]", "Setup a new Hackademic project called [PROJECTNAME]"
+  def new(project_name)
+    say "--------------------------------------------------------------", :cyan
+    say "⫸⫸⫸⫸ Setting up project #{project_name}!", :cyan
+
+    project = "~/Dropbox/Hackademic/Projects/#{project_name}"
     empty_directory(project)
-    empty_directory("#{project}/_WORK_")
+
+    say "»»»»» Creating *_WORKING_* directory:", :green
+    empty_directory("#{project}/_WORKING_")
+    template '../templates/DRAFT.md.tt', "#{project}/_WORKING_/DRAFT.md"
+
+    say "»»»»» Creating *Archive* directory:", :green
     empty_directory("#{project}/Archive")
-    empty_directory("#{project}/Back2it")
-    empty_directory("#{project}/Resources")
+    create_file "#{project}/Archive/.gitkeep"
+
+    say "»»»»» Creating *To-Process* directory:", :green
+    empty_directory("#{project}/To-Process")
+    create_file "#{project}/To-Process/.gitkeep"
+
+    say "»»»»» Creating *Project Notes* directory:", :green
     empty_directory("#{project}/Resources/Notes")
+    create_file "#{project}/Resources/Notes/.gitkeep"
+
+    say "»»»»» Creating *Resources* directory:", :green
+    empty_directory("#{project}/Resources")
+    template '../templates/Config.yml.tt', "#{project}/Resources/Config.yml"
+
+    empty_directory("#{project}/Resources/Figures")
+    create_file "#{project}/Resources/Figures/.gitkeep"
+
+    empty_directory("#{project}/Resources/Data")
+    create_file "#{project}/Resources/Data/.gitkeep"
+
+    empty_directory("#{project}/Resources/templates")
+    create_file "#{project}/Resources/templates/.gitkeep"
+
+    say "»»»»» Creating *Versions* directory:", :green
     empty_directory("#{project}/Versions")
-    empty_directory("#{project}/Projects")
+    create_file "#{project}/Versions/.gitkeep"
+
+    say "»»»»» Creating final files:", :green
+    @project_name = project_name
+    template "../templates/README.md.tt", "#{project}/README.md"
+    template '../templates/CHANGELOG.md.tt', "#{project}/CHANGELOG.md"
+    template '../templates/TODO.txt.tt', "#{project}/TODO.txt"
+
+    say "»»»»» Initializing version control (git) for project...", :green
+    inside "#{project}" do
+      run "git init .", {:capture => true}
+      run "git add .", {:capture => true}
+      run "git commit -m 'Initial commit of #{project_name}'", {:capture => true}
+    end
+
+    say "⫸⫸⫸⫸ DONE!", :cyan
+    say "⫸⫸⫸⫸ Project created at #{project}", :cyan
+    say "--------------------------------------------------------------", :cyan
   end
 
   def self.source_root
     File.dirname(__FILE__)
   end
 
-  def create_config_file
-    template('templates/config.yml', "#{name}/Resources/config.yml")
-  end
-
-  def create_test_file
-    test = options[:test_framework] == "rspec" ? :spec : :test
-    create_file "#{name}/#{test}/#{name}_#{test}.rb"
-  end
+  no_tasks {
 
-  def copy_licence
-    if yes?("Use MIT license?")
-      # Make a copy of the MITLICENSE file at the source root
-      copy_file "MITLICENSE", "#{name}/MITLICENSE"
-    else
-      say "Shame on you…", :red
-    end
-  end
+  }
 
 end

data/templates/CHANGELOG.md.tt

@@ -0,0 +1 @@
+# CHANGELOG

data/templates/DRAFT.md.tt

@@ -0,0 +1,3 @@
+# MAIN DRAFT FOR <%= @project_name %>
+
+*Write lots of good stuff here*

data/templates/README.md.tt

@@ -0,0 +1,9 @@
+# <%= @project_name %>
+
+## Initial Project TODO
+
+- Add a git remote and push upstream
+- Change this README.md file
+- Add credits to README.md
+- Look over Resources/Config.yml
+- Make sure to update CHANGELOG.md periodically!

data/templates/TODO.txt.tt

@@ -0,0 +1 @@
+# TODO.txt

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hackademic
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Matthew Petty
@@ -25,6 +25,11 @@ files:
 - lib/hackademic.rb
 - lib/hackademy/hackademy.rb
 - lib/hackademy/setup.rb
+- templates/CHANGELOG.md.tt
+- templates/Config.yml.tt
+- templates/DRAFT.md.tt
+- templates/README.md.tt
+- templates/TODO.txt.tt
 homepage: http://github.com/kizmeta/hackademic
 licenses:
 - MIT