mdrb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fda49f4b294226a5d59ede6ba7f9c5c6c46c4f3af243487a6a152de9d5102d1e
+  data.tar.gz: 69f751859740f7f5dd750d8d58428fd033adfb40b72db408397c8732e9600fcd
+SHA512:
+  metadata.gz: eefa4e54274d628f54fee3f4a220df94b8333bd26b6f6247d12ddff6f0553b1372aeffed5ca90dfafc90d6ddde7303b3079edce6f276391cddedd28560532f8a
+  data.tar.gz: 6b8b96c11c4ac08db60150b7321e83d2e71041df2e0ba4e0536c0990f3e61337f703fab54b894cf77bbb9e4e4550182c5a26ff713d8df79ce381fa251f96fd1b

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,15 @@
+# Contributor Code of Conduct
+
+Just be nice.
+
+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, ethnicity, 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

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Bryan Lim
+
+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,75 @@
+# md.rb
+
+Create and manage multiple markdown documents easily.
+
+Some of the key features are:
+
+0. Having a simple syntax and api
+1. Generate, read, update and delete multiple markdown
+2. Get json from markdown
+
+# Install
+
+```
+gem install mdrb
+```
+
+```ruby
+require 'mdrb'
+```
+
+# usage
+
+Create markdown
+
+```ruby
+MD.create("first", "# Hello") #first.md
+MD.create("first document", "# Hello") #first-document.md
+```
+
+Create multiple markdown
+
+```ruby
+MD.create_many(["first","second"], ["# first","# second"]) #first.md second.md
+
+MD.create_many(["first document","second document"], ["# first","# second"]) #first-document.md second.md
+
+```
+
+Get json from markdown
+
+```ruby
+MD.create("first", "# first")
+puts json = MD.to_json("first")
+```
+
+Update markdown
+
+```ruby
+MD.update(path, content)
+MD.update_on(which_line, path, content)
+MD.update_many()
+```
+
+Delete markdown
+
+```ruby
+MD.create_many(["first","second"], ["# first", "# second"])
+MD.delete("first")
+MD.delete_many(["first", "second"])
+```
+
+Read markdown
+
+```ruby
+MD.read()
+MD.read_many()
+```
+
+# Testing
+
+rspec
+
+# license
+
+MIT | ytbryan@hey.com

data/lib/mdrb.rb

@@ -0,0 +1,196 @@
+require 'json'
+
+module MD
+
+  #checking the syntax of the markdown
+  # return true or false
+  def self.check(path_to_syntax)
+
+  end
+
+  # MD.exist? is like File.exist?
+  # May include better error next time
+  def self.exist?(path) 
+    return true if existence?(path)
+    false
+  end
+
+  def self.create(path, content)
+    touch(path)
+    write(path, content)
+  end
+
+  def self.create_many(path_array, content_array)
+    return MDError("Different in the length of arrays") if difference_in_length?(path_array, content_array)
+    path_array.each {|each_path|
+      touch(each_path)
+    }
+
+    content_array.each_with_index {|each_content, index|
+      write(path_array[index], each_content)
+    }
+  end
+
+  # This is read but return it 
+  # as a json file
+  def self.to_json(path)
+    array = File.readlines(marked_down(path))
+    answer = []
+    array.each_with_index { |item, i|
+      answer.push(i)
+      answer.push(item)
+    }
+    return Hash[*answer].to_json
+  end
+
+  def self.to_json_many(path_array)
+    answer = []
+    path_array.each {|path|
+      answer.push(to_json(path))
+    }
+    answer
+  end
+
+  # read the file
+  def self.read(path)
+    File.read(marked_down(path))
+  end
+
+  #read many markdown
+  def self.read_many(path_array)
+    answer = []
+    path_array.each {|path|
+      answer.push(File.readlines(marked_down(path)))
+    }
+    answer
+  end
+
+  # move the file
+  def self.move(path, newpath)
+    FileUtils.mv(marked_down(path), marked_down(newpath))
+  end
+
+  #move many of the file
+  def self.move_many(path_array, new_path_array)
+    return MDError("Different in size") if path_array.length != new_path_array.length
+    new_path_array.each_with_index { |each_new_p, i|
+      move(path_array[i], each_new_p)
+    }
+  end
+
+  # remove the file
+  def self.delete(path)
+    File.delete(marked_down(path))
+  end
+  
+  # delete many markdown
+  def self.delete_many(path_array)
+    path_array.each {|path|
+      File.delete(marked_down(path))
+    }
+  end
+
+  # update the markdown
+  def self.update(path, content)
+    return MDError("File too big") if file_too_big?(path) == true    
+    move(path, path+".draft")
+    create(path, content) #create 
+    delete(path+".draft") #delete
+  end
+
+  # update many markdown
+  def self.update_many(path_array, content_array)
+    return MDError("Different in the length of arrays") if difference_in_length?(path_array, content_array)
+    content_array.each_with_index { |each_content, i|
+      update(path_array[i], each_content)
+    }
+  end
+
+  # append to the markdown file
+  def self.append(path, content)
+    add(path, content)
+  end
+
+  # append many markdown
+  def self.append_many(path_array, content_array)
+    content_array.each_with_index {|each_content, i|
+      add(path_array[i], each_content)
+    }
+  end
+
+  # update on the single line
+  def self.update_on(which_line, path, content)
+    return MDError("File too big") if file_too_big?(path)
+    array = File.readlines(path)
+  end
+  
+  # read the line of markdown
+  def self.read_line(which_line, path_to_file)
+    return MDError("File too big") if file_too_big?(path)
+    array = File.readlines(path)
+    array[which_line] if array != nil && array.length >= which_line
+  end
+
+  # list all the markdown files in the 
+  # directory
+  def self.list(path)
+    tasks_array = Dir.entries(path).sort_by { |x| File.birthtime(path + x) }
+    
+    return tasks_array.reject {|f|
+      f[0].include?('.') || is_md_extension? == true
+    }.collect {|x| (path + x)}
+  end
+
+  private #=================================================
+
+  def self.existence?(path)
+    File.exist?(marked_down(path)) == true
+  end
+
+  # TODO check if the file is too big\
+  def self.file_too_big?(path)
+    false
+  end
+
+  # Bryan, you can do better with the naming of marked_down
+  # always produce a path that has .md 
+  def self.marked_down(path)
+    if is_md_extension?(path.dash)
+      path
+    else 
+      path + ".md"
+    end
+  end
+  
+  def self.difference_in_length?(path_array, content_array)
+    path_array.length != content_array.length
+  end
+
+  def self.add(path,content)
+    File.write(marked_down(path.dash), content, mode: "a")
+  end
+
+  def self.write(path, content)
+    File.write(marked_down(path.dash), content, mode: "w")
+  end
+
+  def self.touch(path)
+    FileUtils.touch(marked_down(path.dash))
+  end
+
+  def self.is_md_extension?(path)
+    path[path.length-3..path.length] == ".md"
+  end
+end
+
+module MDError
+  def initialize(str)
+    puts str
+  end
+end
+
+class String
+  def dash
+    self.gsub(" ", "-").strip
+  end
+end

data/lib/mdrb/post_message.rb

@@ -0,0 +1,17 @@
+module MD
+  MESSAGE = "
+
+███╗   ███╗██████╗ ██████╗ ██████╗
+████╗ ████║██╔══██╗██╔══██╗██╔══██╗
+██╔████╔██║██║  ██║██████╔╝██████╔╝
+██║╚██╔╝██║██║  ██║██╔══██╗██╔══██╗
+██║ ╚═╝ ██║██████╔╝██║  ██║██████╔╝
+╚═╝     ╚═╝╚═════╝ ╚═╝  ╚═╝╚═════╝
+
+  ###############################
+
+  Full Changelog -> https://github.com/ytbryan/mdrb/blob/master/changelog.md
+
+  Pull Request ->  https://github.com/ytbryan/mdrb/pulls
+  "
+end

data/lib/mdrb/version.rb

@@ -0,0 +1,3 @@
+module MD
+  VERSION = "0.0.1"
+end

data/mdrb.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mdrb/version'
+require 'mdrb/post_message'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mdrb"
+  spec.version       = MD::VERSION
+  spec.authors       = ["Bryan Lim"]
+  spec.email         = ["ytbryan@hey.com"]
+  spec.summary       = %q{Create and manage markdown}
+  spec.description   = %q{ Create and manage markdown}
+  spec.homepage      = "https://github.com/ytbryan/mdrb"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+  spec.post_install_message = MD::MESSAGE
+  spec.required_ruby_version = ">= 2.0.0"
+  spec.add_dependency 'file-utils' , '~> 0.1.0'
+  spec.add_development_dependency "rspec", "~> 3.9.0"
+  # spec.add_dependency 'thor' , '~> 0.19.4'
+  # spec.add_development_dependency "bundler", "~> 1.10"
+  # spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: mdrb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bryan Lim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: file-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+description: " Create and manage markdown"
+email:
+- ytbryan@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- lib/mdrb.rb
+- lib/mdrb/post_message.rb
+- lib/mdrb/version.rb
+- mdrb.gemspec
+homepage: https://github.com/ytbryan/mdrb
+licenses:
+- MIT
+metadata: {}
+post_install_message: "\n\n███╗   ███╗██████╗ ██████╗ ██████╗\n████╗ ████║██╔══██╗██╔══██╗██╔══██╗\n██╔████╔██║██║
+  \ ██║██████╔╝██████╔╝\n██║╚██╔╝██║██║  ██║██╔══██╗██╔══██╗\n██║ ╚═╝ ██║██████╔╝██║
+  \ ██║██████╔╝\n╚═╝     ╚═╝╚═════╝ ╚═╝  ╚═╝╚═════╝\n\n  ###############################\n\n
+  \ Full Changelog -> https://github.com/ytbryan/mdrb/blob/master/changelog.md\n\n
+  \ Pull Request ->  https://github.com/ytbryan/mdrb/pulls\n  "
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Create and manage markdown
+test_files: []