Skip to content

Commit

Permalink
Updates to release v1.0.6 fixes #142 fixes #143
Browse files Browse the repository at this point in the history
  • Loading branch information
kartik-v committed Dec 17, 2016
1 parent e0d9f1c commit 90d79fe
Show file tree
Hide file tree
Showing 101 changed files with 5,923 additions and 378 deletions.
126 changes: 126 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
Contributing to yii2-tree-manager
=========================
Looking to contribute something to yii2-tree-manager? **Here's how you can help.**

Please take a moment to review this document in order to make the contribution
process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of
the developers managing and developing this open source project. In return,
they should reciprocate that respect in addressing your issue or assessing
patches and features.

Using the issue tracker
-----------------------
When [reporting bugs][reporting-bugs] or
[requesting features][requesting-features], the
[issue tracker on GitHub][issue-tracker] is the recommended channel to use.

The issue tracker **is not** a place for support requests. Refer the
[extension documentation and demos](http://demos.krajee.com/tree-manager) and/or refer to the
[webtips Q & A forum](http://webtips.krajee.com/questions) which are the better places to get help.

Reporting bugs with yii2-tree-manager
-----------------------------
We really appreciate clear bug reports that _consistently_ show an issue
_within yii2-tree-manager_.

The ideal bug report follows these guidelines:

1. **Use the [GitHub issue search][issue-search]** — Check if the issue
has already been reported.
2. **Check if the issue has been fixed** — Try to reproduce the problem
using the code in the `master` branch.
3. **Isolate the problem** — Try to share a demo or a test case that
consistently reproduces the problem.

Please try to be as detailed as possible in your bug report, especially if an
isolated test case cannot be made. Some useful questions to include the answer
to are:

- What steps can be used to reproduce the issue?
- What is the bug and what is the expected outcome?
- What browser(s) and Operating System have you tested with?
- Does the bug happen consistently across all tested browsers?
- What version of jQuery are you using? And what version of yii2-tree-manager?
- Are you using yii2-tree-manager with other plugins?

All of these questions will help others fix and identify any potential bugs.

Requesting features in yii2-tree-manager
------------------------------------------
Before starting work on a major feature for yii2-tree-manager, **read the
[documentation](http://demos.krajee.com/tree-manager) first** or you may risk spending a considerable amount of
time on something which the project developers are not interested in bringing into the project.

### Submitting a pull request

We use GitHub's pull request system for submitting patches. Here are some
guidelines to follow when creating the pull request for your fix.

1. Make sure to create a ticket for your pull request. This will serve as the
bug ticket, and any discussion about the bug will take place there. Your pull
request will be focused on the specific changes that fix the bug.
2. Make sure to reference the ticket you are fixing within your pull request.
This will allow us to close off the ticket once we merge the pull request, or
follow up on the ticket if there are any related blocking issues.
3. Explain why the specific change was made. Not everyone who is reviewing your
pull request will be familiar with the problem it is fixing.
4. Run your tests first. If your tests aren't passing, the pull request won't
be able to be merged. If you're breaking existing tests, make sure that you
aren't causing any breaking changes.
5. Only include source changes. While it's not required, only including changes
from the `src` directory will prevent merge conflicts from occuring. Making
this happen can be as a simple as not committing changes from the `dist`
directory.

By following these steps, you will make it easier for your pull request to be
reviewed and eventually merged.

Triaging issues and pull requests
---------------------------------
Anyone can help the project maintainers triage issues and review pull requests.

### Handling new issues

yii2-tree-manager regularly receives new issues which need to be tested and organized.

When a new issue that comes in that is similar to another existing issue, it
should be checked to make sure it is not a duplicate. Duplicates issues should
be marked by replying to the issue with "Duplicate of #[issue number]" where
`[issue number]` is the url or issue number for the existing issue. This will
allow the project maintainers to quickly close off additional issues and keep
the discussion focused within a single issue.

If you can test issues that are reported to yii2-tree-manager that contain test cases and
confirm under what conditions bugs happen, that will allow others to identify
what causes a bug quicker.

### Reviewing pull requests

It is very common for pull requests to be opened for issues that contain a clear
solution to the problem. These pull requests should be rigorously reviewed by
the community before being accepted. If you are not sure about a piece of
submitted code, or know of a better way to do something, do not hesitate to make
a comment on the pull request.

### Reviving old tickets

If you come across tickets which have not been updated for a while, you are
encouraged to revive them. While this can be as simple as saying `:+1:`, it is
best if you can include more information on the issue. Common bugs and feature
requests are more likely to be fixed, whether it is by the community or the
developers, so keeping tickets up to date is encouraged.

Licensing
---------

It should also be made clear that **all code contributed to yii2-tree-manager** must be
licensable under the [BSD-3 license][licensing]. Code that cannot be released
under this license **cannot be accepted** into the project.

[issue-search]: https://github.com/kartik-v/yii2-tree-manager/search?q=&type=Issues
[issue-tracker]: https://github.com/kartik-v/yii2-tree-manager/issues
[licensing]: https://github.com/kartik-v/yii2-tree-manager/blob/master/LICENSE.md
[reporting-bugs]: #reporting-bugs-with-yii2-tree-manager
[requesting-features]: #requesting-features-in-yii2-tree-manager
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## Prerequisites

- [ ] I have searched for similar issues in both open and closed tickets and cannot find a duplicate.
- [ ] The issue still exists against the latest `master` branch of yii2-tree-manager.
- [ ] This is not an usage question. I confirm having gone through and read the [documentation](http://demos.krajee.com/tree-manager) and [demos](http://demos.krajee.com/tree-manager-demo/tree-view).
- [ ] This is not a general programming / coding question. (Those should be directed to the [webtips Q & A forum](http://webtips.krajee.com/questions)).
- [ ] I have attempted to find the simplest possible steps to reproduce the issue.
- [ ] I have included a failing test as a pull request (Optional).

## Steps to reproduce the issue

1.
2.
3.

## Expected behavior and actual behavior

When I follow those steps, I see...

I was expecting...

## Environment

#### Browsers

- [ ] Google Chrome
- [ ] Mozilla Firefox
- [ ] Internet Explorer
- [ ] Safari

#### Operating System

- [ ] Windows
- [ ] Mac OS X
- [ ] Linux
- [ ] Mobile

#### Libraries

- jQuery version:
- yii2-tree-manager version:

## Isolating the problem

- [ ] This bug happens [on the demos page](http://demos.krajee.com/tree-manager-demo/tree-view)
- [ ] The bug happens consistently across all tested browsers
- [ ] This bug happens when using yii2-tree-manager without other plugins.
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Scope
This pull request includes a

- [ ] Bug fix
- [ ] New feature
- [ ] Translation

## Changes
The following changes were made (this change is also documented in the [change log](https://github.com/kartik-v/yii2-tree-manager/blob/master/CHANGE.md)):

-
-
-

## Related Issues
If this is related to an existing ticket, include a link to it as well.
11 changes: 10 additions & 1 deletion CHANGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Change Log: `yii2-tree-manager`

## Version 1.0.6

**Date:** 12-Jul-2016
**Date:** 16-Dec-2016

- (enh #98): Add new bool property `TreeViewInput::autoCloseOnSelect`.
- (enh #99): Add Chinese translations
Expand All @@ -19,6 +19,15 @@ Change Log: `yii2-tree-manager`
- (bug #127): Fix migration namespace.
- (bug #128): Correct asset dependency.
- (enh #129): More correct defaulting of CSS classes.
- (enh #137): Add Dutch translations.
- (enh #138): Add Finnish translations.
- (enh #142): Implement Krajee Dialog for all alerts and confirmation.
- (enh #143): Enhance security for NodeController actions using a stateless signature to prevent data tampering:
- New property `Module::treeEncryptSalt` available to generate a stateless hashed signature.
- If `treeEncryptSalt` is not set, it will be randomly generated and stored in a session variable.
- Tree configuration settings will be signed and the same data via POST will be cross checked using `yii\base\Security::hashData` and `yii\base\Security::validateData`.
- Add github contribution and issue/PR logging templates.
- Update message config to include all default standard translation files.

## Version 1.0.5

Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2015 - 2016, Kartik Visweswaran
Copyright (c) 2015 - 2017, Kartik Visweswaran
Krajee.com
All rights reserved.

Expand Down
52 changes: 49 additions & 3 deletions Module.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?php

/**
* @copyright Copyright &copy; Kartik Visweswaran, Krajee.com, 2015 - 2016
* @copyright Copyright &copy; Kartik Visweswaran, Krajee.com, 2015 - 2017
* @package yii2-tree
* @version 1.0.6
*/
Expand All @@ -20,18 +20,50 @@
*/
class Module extends \kartik\base\Module
{
/**
* The module name for Krajee treeview
*/
const MODULE = 'treemanager';

/**
* Manage node action
*/
const NODE_MANAGE = 'manage';
/**
* Remove node action
*/
const NODE_REMOVE = 'remove';
/**
* Move node action
*/
const NODE_MOVE = 'move';
/**
* Save node action
*/
const NODE_SAVE = 'save';

/**
* Tree details form view - Section Part 1
*/
const VIEW_PART_1 = 1;
/**
* Tree details form view - Section Part 2
*/
const VIEW_PART_2 = 2;
/**
* Tree details form view - Section Part 3
*/
const VIEW_PART_3 = 3;
/**
* Tree details form view - Section Part 4
*/
const VIEW_PART_4 = 4;
/**
* Tree details form view - Section Part 5
*/
const VIEW_PART_5 = 5;
/**
* Session key variable name for storing the tree configuration encryption salt.
*/
const SALT_SESS_KEY = "krajeeTreeConfigSalt";

/**
* @var array the configuration of nested set attributes structure
Expand Down Expand Up @@ -75,13 +107,27 @@ class Module extends \kartik\base\Module
'yii\validators\ValidationAsset'
];

/**
* @var string a random salt that will be used to generate a hash signature for tree configuration. If not set, this
* will be generated using [[\yii\base\Security::generateRandomKey()]] to generate a random key. The randomly
* generated salt will be stored in a session variable identified by [[SALT_SESS_KEY]].
*/
public $treeEncryptSalt;

/**
* @inherit doc
*/
public function init()
{
$this->_msgCat = 'kvtree';
parent::init();
if (!isset($this->treeEncryptSalt)) {
$session = Yii::$app->session;
if (!$session->get(self::SALT_SESS_KEY)) {
$session->set(self::SALT_SESS_KEY, Yii::$app->security->generateRandomKey());
}
$this->treeEncryptSalt = $session->get(self::SALT_SESS_KEY);
}
$this->treeStructure += [
'treeAttribute' => 'root',
'leftAttribute' => 'lft',
Expand Down
Loading

0 comments on commit 90d79fe

Please sign in to comment.