power-build 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4deaba60aee516b39ec1f141c758e4afeed77dac
-  data.tar.gz: 71c47bd357385c7186ded93c4f76e21b1844859a
+  metadata.gz: 24f12087f935cb4d1c84126aed880d578539d367
+  data.tar.gz: fd5e8bec4bd26673386cf6adf9676a8f7d880891
 SHA512:
-  metadata.gz: 961f890c061123509f04ec56a8aca9664275082a2e20828dc05b9933cc005abe241a299b291284f96492e41f9b2dc6520f04fb23a8ad09b2836ee1ed99311b60
-  data.tar.gz: 433c70b5a2708c735f83d8881c0e9586126190093e1760b9de597f97b986bfe42fe962a8fa4ad06c9a537bf6a9f5a51645c9ad690d059c5d6b1721f34008bd00
+  metadata.gz: fd49c7a04878622724aa7594823a496e3d8bd8c321ad3dbc1a965bde47acd04fb1f20feb7b6a30803306a1297a4eca5c79bf3e7568baaa05b4620a8d81763556
+  data.tar.gz: 993d884a1e6d171f53b76105d70ae6519f8b7cc01cc081d17351de1a6a94e0ba131b9958ce03450bb47f57d29893f23184a0ade07d30b119de14b940fb09cf72

data/README.md

@@ -1,8 +1,10 @@
 # Power Build
 
-Power Build is a photo album builder which generates a site based on the images in a project. It works as a command line application.
+[![Gem Version](https://badge.fury.io/rb/power-build.svg)](http://badge.fury.io/rb/power-build) [![Code Climate](https://codeclimate.com/github/nkj20932/power-build/badges/gpa.svg)](https://codeclimate.com/github/nkj20932/power-build)
 
-#### Visit [Demo Site](http://cstony0917.github.io/warofpic/) for a general understanding.
+Power Build is a photo album builder which generates a site based on the images in a project. It works from command line.
+
+#### [Demo Site](https://github.com/nkj20932/image_stack/tree/gh-pages)
 
 ## Requirement
 
@@ -34,7 +36,7 @@ It creates a config file in your project directory. You can adjust the content d
 $power build
 ```
 
-You can skip the `build` and just run `power`. This command generates a static site which allows you to host on github pages. Basically it creates a `index.html` and a folder `assets` with other pages in it.
+You can skip the `build` and just run `power`. This command generates a static site which allows you to host on github pages. Basically it creates a `index.html` and a folder `assets` with other stuff in it.
 
 ```
 $power delete
@@ -42,6 +44,12 @@ $power delete
 
 Clean all files generated by power-build.
 
+Further commands and shortcuts will display at:
+
+```
+$power help
+```
+
 ## Config
 
 The config file looks like this:
@@ -76,7 +84,7 @@ My_project_folder
 |-- image_root_folder
 ```
 
-If so, after site generation, your folder will look like this:
+If so, your folder will look like this after site generation:
 
 ```
 My_project_folder
@@ -86,21 +94,50 @@ My_project_folder
 |-- index.html
 ```
 
-However, in your image folder, the images should be stored by categories like this:
+Everything in your project root folder will be ignored. Files already in your `assets` directory will not be overwritten during build, so any change in `custom.js` or `custom.css` will preserve.
+
+## Image Arrangement
+
+The image folder should be stored by categories like this:
 
 ```
 image_root_folder
 |-- category_1
-|    |--  image_1
-|    |--  image_2
-|    |--  image_3
+|    |--  image_1.jpg
+|    |--  image_2.png
+|    |--  image_3.gif
 |
 |-- category_2
 |-- category_3
+|-- image_1.jpg
+|-- image_2.png
+```
+
+All images will be categorized with their folder name. Images not in a subfolder will be categorized as "Uncategorized". For example:
+
+```
+my_album/
+|-- family/
+|    |--  brother.jpg
+|    |--  mother.png
+|    |--  sister.gif
+|
+|-- my_life/
+|-- my_pet/
+|-- James Bond.jpg
+|-- Samuel Jackson.png
 ```
 
-Only the structure is followed can the site be generated in the correct format as in the [demo](http://cstony0917.github.io/warofpic/).
+`brother.jpg` will be labelled as "family", while `James Bond.jpg` and `Samuel Jacson.png` will be labelled as "Uncategorized".
+
+Only this structure followed can the site be generated in the correct format as in the [demo](https://github.com/nkj20932/image_stack/tree/gh-pages).
+
+## Deployment
+
+After generation, push from the branch `gh-pages` to Github and enjoy.
+
+#### [GitHub Pages Hosting Instruction](https://pages.github.com/)
 
 ## Issues & Contribution
 
-The project follows MIT Licence. Any issue, pull-request, feature-request, or comment is welcome.
+The project follows MIT Licence. Any issue, pull-request, feature-request, or comment is welcomed.

data/lib/assets/css/custom.css

@@ -1,40 +0,0 @@
-/*!
- * Start Bootstrap - Thumbnail Gallery HTML Template (http://startbootstrap.com)
- * Code licensed under the Apache License v2.0.
- * For details, see http://www.apache.org/licenses/LICENSE-2.0.
- */
-
-body {
-    padding-top: 70px; /* Required padding for .navbar-fixed-top. Change if height of navigation changes. */
-}
-
-.thumb {
-    margin-bottom: 30px;
-}
-
-footer {
-    margin: 50px 0;
-}
-
-img.img-responsive {
-  height: 200px;
-}
-
-img.image-responsive.single-image {
-  max-width: 1140px;
-  display: block;
-  margin: 0 auto;
-}
-
-.download, .home {
-  margin-top: 30px;
-}
-
-.home {
-  margin-left: 20px;
-}
-
-.copyright {
-  color: #C2C2C2;
-  margin-top: -25px;
-}

data/lib/assets/css/theme.css

@@ -0,0 +1,59 @@
+/*!
+ * Start Bootstrap - Thumbnail Gallery HTML Template (http://startbootstrap.com)
+ * Code licensed under the Apache License v2.0.
+ * For details, see http://www.apache.org/licenses/LICENSE-2.0.
+ */
+
+body {
+    padding-top: 70px; /* Required padding for .navbar-fixed-top. Change if height of navigation changes. */
+}
+
+.thumb {
+    margin-bottom: 30px;
+}
+
+footer {
+    margin: 50px 0;
+}
+
+img.img-responsive {
+  height: 200px;
+}
+
+img.image-responsive.single-image {
+  max-width: 1140px;
+  display: block;
+  margin: 0 auto;
+}
+
+.download, .home {
+  margin-top: 30px;
+}
+
+.home {
+  margin-left: 20px;
+}
+
+.copyright {
+  color: #C2C2C2;
+  margin-top: -25px;
+}
+
+.btn {
+  margin-left: 10px;
+  margin-right: 10px;
+}
+
+@media all and (max-width: 600px) {
+  img.img-responsive {
+    height: 100px;
+  }
+
+  h1.page-header {
+    font-size: 26px;
+  }
+
+  img.image-responsive.single-image {
+    max-width: 100%;
+  }
+}

data/lib/assets/partials/_footer.html.erb

@@ -1,8 +1,17 @@
 <footer>
-<div class="row">
-  <div class="copyright col-lg-12 text-center">
-    <p><%= i_copyright %> <%= "#{title} " %><%= Time.now.strftime("%Y") %></p>
+  <div class="row">
+    <% if copyright_display %>
+      <div class="copyright col-lg-12 text-center">
+        <p><%= i_copyright %> <%= "#{title} " %><%= Time.now.strftime("%Y") %></p>
+      </div>
+    <% end %>
   </div>
-</div>
+  <script src="<%= resource_prefix %>assets/js/jquery.js"></script>
+  <script src="<%= resource_prefix %>assets/js/bootstrap.min.js"></script>
+  <script src="<%= resource_prefix %>assets/js/theme.js"></script>
+  <script src="<%= resource_prefix %>assets/js/custom.js"></script>
+  <!-- <script src="https://cdnjs.cloudflare.com/ajax/libs/zclip/1.1.2/jquery.zclip.js"></script> -->
 </footer>
+<!-- The credit of this design goes to David Miller -->
+<!-- Check more for detail: http://startbootstrap.com/template-overviews/thumbnail-gallery/ -->
 

data/lib/assets/partials/_head.html.erb

@@ -6,5 +6,6 @@
   <meta name="author" content="">
   <link href="<%= resource_prefix %>assets/css/bootstrap.min.css" rel="stylesheet">
   <link href="<%= resource_prefix %>assets/css/custom.css" rel="stylesheet">
+  <link href="<%= resource_prefix %>assets/css/theme.css" rel="stylesheet">
   <title><%= title %></title>
 </head>

data/lib/assets/power-build.config

@@ -11,5 +11,9 @@
   // Website language: either "zh-tw" or "en"
   "language": "zh-tw",
 
+  // Enabling copyright display, 'false' if you don't wait it
+  "Copyright Display": true,
+
+  // Not enabled yet
   "Push to GitHub after generation": false
 }

data/lib/assets/templates/category.html.erb

@@ -11,7 +11,7 @@
           <% current_category[:images].each do |image| %>
             <div class="col-lg-3 col-md-4 col-xs-6 thumb">
               <a class="thumbnail" href="<%= image %>.html">
-                <img class="img-responsive" src='<%= "#{resource_prefix}#{root_folder}/#{current_category[:tag]}/#{image}" %>' alt="">
+                <img class="img-responsive" src='<%= "#{resource_prefix}#{root_folder}#{bridge}/#{image}" %>' alt="">
               </a>
             </div>
           <% end %>
@@ -19,10 +19,5 @@
       <hr>
       <%= footer %>
     </div>
-    <script src="<%= resource_prefix %>assets/js/jquery.js"></script>
-    <script src="<%= resource_prefix %>assets/js/bootstrap.min.js"></script>
-    <script src="<%= resource_prefix %>assets/js/custom.js"></script>
   </body>
-  <!-- The credit of this design goes to David Miller -->
-  <!-- Check more for detail: http://startbootstrap.com/template-overviews/thumbnail-gallery/ -->
 </html>

data/lib/assets/templates/index.html.erb

@@ -9,10 +9,11 @@
           <h1 class="page-header"><%= i_header %></h1>
         </div>
         <% image_collection.each do |category| %>
+          <% bridge = category[:tag] == i_uncategorized ? "" : "/#{category[:tag]}" %>
           <% category[:images].each do |image| %>
             <div class="col-lg-3 col-md-4 col-xs-6 thumb">
               <a class="thumbnail" href="<%= "assets/#{category[:tag]}/#{image}.html" %>">
-                <img class="img-responsive" src='<%= "#{root_folder}/#{category[:tag]}/#{image}" %>' alt="">
+                <img class="img-responsive" src='<%= "#{root_folder}#{bridge}/#{image}" %>' alt="">
               </a>
             </div>
           <% end %>
@@ -21,10 +22,5 @@
       <hr>
       <%= footer %>
     </div>
-    <script src="assets/js/jquery.js"></script>
-    <script src="assets/js/bootstrap.min.js"></script>
-    <script src="assets/js/custom.js"></script>
   </body>
-  <!-- The credit of this design goes to David Miller -->
-  <!-- Check more for detail: http://startbootstrap.com/template-overviews/thumbnail-gallery/ -->
 </html>

data/lib/assets/templates/show.html.erb

@@ -9,7 +9,7 @@
           <h1 class="page-header"><a href="../../index.html"><%= i_header %></a> > <a href="index.html"><%= current_category[:tag] %></a> > <%= title %></h1>
           <img class="image-responsive single-image" src="<%= current_image_source %>" alt="">
           <div class="text-center">
-            <a class="btn btn-lg btn-primary download" href="<%= current_image_source %>" download="<%= title %>" title="image"><%= i_download %></a>
+            <a class="btn btn-lg btn-primary download" href="<%= current_image_source %>" download="<%= title %>" ><%= i_download %></a>
             <a class="btn btn-lg btn-default home" href="<%= resource_prefix %>index.html"><%= i_home %></a>
           </div>
         </div>
@@ -17,10 +17,5 @@
       <hr>
       <%= footer %>
     </div>
-    <script src="<%= resource_prefix %>assets/js/jquery.js"></script>
-    <script src="<%= resource_prefix %>assets/js/bootstrap.min.js"></script>
-    <script src="<%= resource_prefix %>assets/js/custom.js"></script>
   </body>
-  <!-- The credit of this design goes to David Miller -->
-  <!-- Check more for detail: http://startbootstrap.com/template-overviews/thumbnail-gallery/ -->
 </html>

data/lib/power-build/base.rb

@@ -9,23 +9,19 @@ module PowerBuild
     map %w[b] => :build
     default_task :build
     def build 
-      if File.file? "power-build.config"
-        Constructor.new.copy_assets
-        Constructor.new(:config).generate_site
-        puts "Done!"
-      else
-        puts "No config file found. Run 'power init' first."
-      end
+      config_exists?
+      image_root_folder_exists?
+      Constructor.new.copy_assets
+      Constructor.new(:config).generate_site
+      puts "Done!"
     end
 
     desc "init, i", "Start with a config file."
     map %w[i] => :init
     def init
-      unless in_power_build_project
-        Constructor.new.build_config
-      else
-        puts "Already in a power-build project."
-      end
+      config_already_exists?
+      in_power_build_project?
+      Constructor.new.build_config
     end
 
     desc "delete, d", "Remove all files generated by Power Build"
@@ -34,12 +30,6 @@ module PowerBuild
       Constructor.new.remove_config
     end
 
-    desc "config, open, o", "Open the config file for you if you're this lazy"
-    map %w[open, o] => :config
-    def config
-      Constructor.new.open_config
-    end
-
     map %w[--version -v] => :__print_version
     desc "--version, -v", "show version"
     def __print_version
@@ -53,12 +43,41 @@ module PowerBuild
     # end
 
     private
-      def in_power_build_project
+      def in_power_build_project?
         count = Dir.pwd.count("/") - 1
+        find_config = false
         for i in 0..count do
-         @respond = true if File.file?("../" * i + "power-build.config")
+          find_config = true if File.file?("../" * i + "power-build.config")
+        end
+        if find_config
+          puts "Already in a power-build project."
+          abort
+        end
+      end
+
+      def config_exists?
+        unless File.file? "power-build.config"
+          puts "No config file found. Run 'power init' first."
+          abort
+        end
+      end
+
+      def config_already_exists?
+        if File.file? "power-build.config"
+          puts "Config file already exists. Either:"
+          puts "1. Run 'power build' to build."
+          puts "2. Run 'power delete' to delete all."
+          abort
+        end
+      end
+
+      def image_root_folder_exists?
+        config = Helper.read_config 
+        folder = config["root_folder"]
+        unless File.directory? folder
+          puts "Image folder '#{folder}' not found." 
+          abort
         end
-        return @respond
       end
   end
 end

data/lib/power-build/constructor.rb

@@ -2,26 +2,21 @@ require 'colorize'
 require 'erb'
 require 'ostruct'
 require 'json'
+require 'power-build/helper'
+require 'power-build/i18n'
 
 module PowerBuild
   class Constructor
-
     def initialize(config=nil)
       @assets_base = "../../assets"
       variables_set if config
     end
 
     def build_config
-      if File.file? "power-build.config"
-        puts "Config file already exists. Either:"
-        puts "1. Run 'power build' to build."
-        puts "2. Run 'power delete' to delete all."
-      else
-        @assets_base = "../../assets"
-        config = "power-build.config"
-        FileUtils.cp File.expand_path("#{@assets_base}/power-build.config", __FILE__), config
-        puts "Created: ".green + "power-build.config"
-      end
+      @assets_base = "../../assets"
+      config = "power-build.config"
+      FileUtils.cp File.expand_path("#{@assets_base}/power-build.config", __FILE__), config
+      puts "Created: ".green + "power-build.config"
     end
 
     def copy_assets
@@ -51,7 +46,7 @@ module PowerBuild
       @variables.title = @config["title"]
       @variables.resource_prefix = ""
       update_partials
-      render_page("index")
+      render_("index")
       puts "Created: ".green + "index.html"
     end
 
@@ -59,8 +54,6 @@ module PowerBuild
       if File.file? "power-build.config"
         FileUtils.remove "power-build.config"
         puts "Removed:".red + " power-build.config"
-      else
-        puts "Config file does not exist."
       end
       if File.directory? "assets"
         FileUtils.rm_rf "assets"
@@ -72,26 +65,19 @@ module PowerBuild
       end
     end
 
-    def open_config
-      if File.file? "power-build.config"
-        %x[open power-build.config]
-      else
-        puts "Config file does not exist."
-      end
-    end
-
   private
 
     def variables_set
-      @config = read_config
+      @config = Helper.read_config
       @variables = OpenStruct.new(title: @config["title"],
                                   root_folder: @config["root_folder"],
                                   site: @config["site"],
                                   host_link: @config["host_link"],
                                   host_display_text: @config["host_display_text"],
-                                  resource_prefix: ""
+                                  resource_prefix: "",
+                                  copyright_display: @config["Copyright Display"]
                                  )
-      i18n(@config["language"]).each {|key, value| @variables.send("#{key.to_s}=".to_sym, value) }
+      I18n.load(@config["language"]).each {|key, value| @variables.send("#{key.to_s}=".to_sym, value) }
     end
 
     def copy_assets_dir(dir_name)
@@ -115,21 +101,6 @@ module PowerBuild
       end
     end
 
-    def read_config
-      begin
-        JSON.parse(File.read("power-build.config"))
-      rescue JSON::ParserError
-        puts "============================================================"
-        puts "Oops, make sure 'power-build.config' is in correct JSON format."
-        puts "1. Wrap the whole content in brackets {}"
-        puts "2. Wrap each key and value with quotes ''"
-        puts "3. Separate each setting with comma ,"
-        puts "If you can't fix it, run 'power delete' to start over again."
-        puts "============================================================"
-        raise JSON::ParserError
-      end
-    end
-
     def update_partials
       add_partial("head")
       add_partial("navbar")
@@ -142,40 +113,53 @@ module PowerBuild
       @variables.send("#{partial}=".to_sym, rendered)
     end
 
-    def render_page(page)
-      content = File.read(File.expand_path("#{@assets_base}/templates/#{page}.html.erb", __FILE__))
-      erb = ERB.new(content).result(@variables.instance_eval{binding})
-      File.open("#{page}.html", "w") {|file| file.write(erb)}
-    end
-
     def collect_images
       collection = []
       root_dir = @config["root_folder"]
-      dirs = Dir.entries(root_dir)
-      dirs.delete(".")
-      dirs.delete("..")
+      dirs = Dir.entries(root_dir).delete_folder_extra
       dirs.each do |dir|
         if File.directory? "#{root_dir}/#{dir}"
-          images = Dir.entries("#{root_dir}/#{dir}")
-          images.delete(".")
-          images.delete("..")
+          images = Dir.entries("#{root_dir}/#{dir}").delete_folder_extra
           category = {:tag => dir, :images => []}
           images.each do |image|
-            if File.file? "#{root_dir}/#{dir}/#{image}"
-              if ["jpg", "png", "gif", "peg"].include? image[-3..-1].downcase
-                category[:images].push(image)
-              end
+            if File.file?("#{root_dir}/#{dir}/#{image}")
+              category[:images].push(image) if ["jpg", "png", "gif", "peg"].include? image[-3..-1].downcase
             end
           end
           collection.push(category)
         end
       end
+      uncategorized = {:tag => @variables[:i_uncategorized], :images => []}
+      dirs.each do |image|
+        if File.file?("#{root_dir}/#{image}") && image.include?(".")
+          uncategorized[:images].push(image) if ["jpg", "png", "gif", "peg"].include? image[-3..-1].downcase
+        end
+      end
+      collection.push(uncategorized) if uncategorized[:images].length > 0
+
       return collection
     end
 
-    def create_page_by(category)
+    def variables_set_by(category)
       @dir = FileUtils.mkdir_p("assets/#{category[:tag]}").first
       @variables.current_category = category
+      if category[:tag] == @variables[:i_uncategorized] 
+        @variables.bridge = ""
+      else
+        @variables.bridge = "/#{category[:tag]}"
+      end
+    end
+
+    def variables_set_by_each(category, image)
+      @variables.current_image = "#{@dir}/#{image}"
+      bridge = category[:tag] == @variables[:i_uncategorized] ? "" : "/#{category[:tag]}"
+      @variables.current_image_source = "../../#{@config["root_folder"]}#{bridge}/#{image}"
+      @variables.current_title = image
+      @variables.title = @variables.current_title
+    end
+
+    def create_page_by(category)
+      variables_set_by(category)
       content = File.read(File.expand_path("#{@assets_base}/templates/category.html.erb", __FILE__))
       erb = ERB.new(content).result(@variables.instance_eval{binding})
       File.open("#{@dir}/index.html", "w") {|file| file.write(erb)}
@@ -183,35 +167,18 @@ module PowerBuild
     end
 
     def create_page_by_each(category, image)
-      @variables.current_image = "#{@dir}/#{image}"
-      @variables.current_image_source = "../../#{@config["root_folder"]}/#{category[:tag]}/#{image}"
-      @variables.current_title = image
-      @variables.title = @variables.current_title
+      variables_set_by_each(category, image)
       content = File.read(File.expand_path("#{@assets_base}/templates/show.html.erb", __FILE__))
       erb = ERB.new(content).result(@variables.instance_eval{binding})
       File.open("#{@dir}/#{@variables.current_title}.html", "w") {|file| file.write(erb)}
       puts "Created: ".green + "#{@dir}/#{@variables.current_title}.html"
     end
 
-    def i18n(setting)
-      case setting
-      when "zh-tw"
-        {
-          i_header: "總覽",
-          i_category: "類別",
-          i_copyright: "版權所有",
-          i_download: "下載",
-          i_home: "首頁"
-        }
-      when "en"
-        {
-          i_header: "Overview",
-          i_category: "Categories",
-          i_copyright: "Copyright",
-          i_download: "Download",
-          i_home: "Home"
-        }
-      end
+    def render_(index)
+      content = File.read(File.expand_path("#{@assets_base}/templates/index.html.erb", __FILE__))
+      erb = ERB.new(content).result(@variables.instance_eval{binding})
+      File.open("index.html", "w") {|file| file.write(erb)}
     end
+
   end
 end