jekyll-categorizer 0.1.0 → 1.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccce1e5afaf3a8adfe5d3fc96ff21c07fd64551f
-  data.tar.gz: f980e82018fa566365a94dc5dd5d3e43f122defb
+  metadata.gz: 7952498c536ca77d814e1a9aa438f832aa395c5d
+  data.tar.gz: da4bfc39b806de164f654829406bea2cdb534343
 SHA512:
-  metadata.gz: 123097668fae678c793ce0118ccea82eead589858d33d3adba7e94824259c13e2fe5d5ab79b8cf595d33ec58ab95f6593931986a78ea5c43774afa34ba43f291
-  data.tar.gz: 739ed3172cc9162a47775609e561c793524f44971b84cd39b2e44ca76412748103e0a7aaa0f0e5c0f117e768d5eefe7a002e45a4dd855240b72af2b23185c6d4
+  metadata.gz: c62ac91dbabf22de9636b529bf4c3225761f9f052a63c6b1754109dfb99df80e8f6fba9f08143a8bb45c6d8c28de4b88ad10ffba6319047d9be8fe0a750e26c3
+  data.tar.gz: 05083f3741aec2964b3947a8f1aceb6f99fc5346029c6ab423979e1fdf2f87138a994da48f01c855b5326d9155a383e36ea717339d46c0c96c4d8d3dc0f0a2a7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ignacio Galindo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# Jekyll::Categorizer
+
+A jekyll plugin to generate category pages using your own template.
+
+## Install
+
+Add `jekyll-categorizer` to your site's Gemfile under the
+`jekyll_plugins` group:
+
+
+```ruby
+group "jekyll_plugins" do
+  gem "jekyll-categorizer"
+end
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+Configure in `_config.yml` the following settings:
+
+```yaml
+jekyll_categorizer:
+  namespace: categories # this will be used for URL namespacing (E.g. /categories/foo)
+  layout:    category   # this should be your own layout
+```
+
+and lastly, in your specified layout, make use of the following snippet:
+
+```
+# ...
+{% for post in site.categories[page.category] %}
+# ...
+{% endfor %}
+# ...
+```
+
+To iterate over every category post. This should build a category page for every category found in your
+articles under `_posts`.
+
+E.g. If you have a category `foo` then you'd be able to see every post
+for that category under `/categories/foo.html` (using categories
+namespace)
+
+## License
+
+The [MIT License](LICENSE.md).
+
+## Contributing
+
+Check [Code of Coduct](CODE_OF_CONDUCT.md).
+
+1. [Fork it](https://github.com/joiggama/jekyll-categorizer/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/jekyll-categorizer.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake',       '~> 10.0'
   spec.add_development_dependency 'pry-byebug', '~> 3.2.0'
 
-  spec.add_runtime_dependency     'jekyll', '~> 2.5.3'
+  spec.add_runtime_dependency     'jekyll', '>= 2.5.3'
 end

data/lib/jekyll/categorizer/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Categorizer
-    VERSION = '0.1.0'
+    VERSION = "1.0.0.alpha"
   end
 end

data/lib/jekyll/categorizer.rb

@@ -24,10 +24,10 @@ module Jekyll
       def initialize(site, category)
         @site  = site
         @base  = site.source
-        @dir   = site.config['categorizer']['dir'].gsub(/^\/*(.*)\/*$/, '\1')
+        @dir   = site.config["jekyll_categorizer"]["namespace"].gsub(/^\/*(.*)\/*$/, '\1')
         @name  = "#{category}.html"
 
-        template_path = File.join(@base, '_layouts', "#{site.config['categorizer']['layout']}.html")
+        template_path = File.join(@base, "_layouts", "#{site.config["jekyll_categorizer"]["layout"]}.html")
 
         self.process(@name)
 
@@ -36,7 +36,7 @@ module Jekyll
           template_dir    = File.dirname(template_path)
           template        = File.basename(template_path)
           self.read_yaml(template_dir, template)
-          self.data['category']    = category
+          self.data["category"]    = category
         else
           @perform_render = false
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-categorizer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0.alpha
 platform: ruby
 authors:
 - Ignacio Galindo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,14 +56,14 @@ dependencies:
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.3
 description: " A Jekyll plugin to generate custom category index pages. Bring your
@@ -75,7 +75,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CODE_OF_CONDUCT.md
 - Gemfile
+- LICENSE.md
+- README.md
 - jekyll-categorizer.gemspec
 - lib/jekyll/categorizer.rb
 - lib/jekyll/categorizer/version.rb
@@ -94,12 +97,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: Generate simple category index pages with ease.